Package com.pulumi.aws.apigateway

Class MethodArgs.Builder

  • Enclosing class:
    MethodArgs
    public static final class MethodArgs.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

      • Builder

        public Builder​(MethodArgs defaults)

    • Method Detail

      • apiKeyRequired

        public MethodArgs.Builder apiKeyRequired​(@Nullable
                                         com.pulumi.core.Output<java.lang.Boolean> apiKeyRequired)
        Parameters:
        apiKeyRequired - Specify if the method requires an API key
        Returns:
        builder

      • apiKeyRequired

        public MethodArgs.Builder apiKeyRequired​(java.lang.Boolean apiKeyRequired)
        Parameters:
        apiKeyRequired - Specify if the method requires an API key
        Returns:
        builder

      • authorization

        public MethodArgs.Builder authorization​(com.pulumi.core.Output<java.lang.String> authorization)
        Parameters:
        authorization - Type of authorization used for the method (`NONE`, `CUSTOM`, `AWS_IAM`, `COGNITO_USER_POOLS`)
        Returns:
        builder

      • authorization

        public MethodArgs.Builder authorization​(java.lang.String authorization)
        Parameters:
        authorization - Type of authorization used for the method (`NONE`, `CUSTOM`, `AWS_IAM`, `COGNITO_USER_POOLS`)
        Returns:
        builder

      • authorizationScopes

        public MethodArgs.Builder authorizationScopes​(@Nullable
                                              com.pulumi.core.Output<java.util.List<java.lang.String>> authorizationScopes)
        Parameters:
        authorizationScopes - Authorization scopes used when the authorization is `COGNITO_USER_POOLS`
        Returns:
        builder

      • authorizationScopes

        public MethodArgs.Builder authorizationScopes​(java.util.List<java.lang.String> authorizationScopes)
        Parameters:
        authorizationScopes - Authorization scopes used when the authorization is `COGNITO_USER_POOLS`
        Returns:
        builder

      • authorizationScopes

        public MethodArgs.Builder authorizationScopes​(java.lang.String... authorizationScopes)
        Parameters:
        authorizationScopes - Authorization scopes used when the authorization is `COGNITO_USER_POOLS`
        Returns:
        builder

      • authorizerId

        public MethodArgs.Builder authorizerId​(@Nullable
                                       com.pulumi.core.Output<java.lang.String> authorizerId)
        Parameters:
        authorizerId - Authorizer ID to be used when the authorization is `CUSTOM` or `COGNITO_USER_POOLS`
        Returns:
        builder

      • authorizerId

        public MethodArgs.Builder authorizerId​(java.lang.String authorizerId)
        Parameters:
        authorizerId - Authorizer ID to be used when the authorization is `CUSTOM` or `COGNITO_USER_POOLS`
        Returns:
        builder

      • httpMethod

        public MethodArgs.Builder httpMethod​(com.pulumi.core.Output<java.lang.String> httpMethod)
        Parameters:
        httpMethod - HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
        Returns:
        builder

      • httpMethod

        public MethodArgs.Builder httpMethod​(java.lang.String httpMethod)
        Parameters:
        httpMethod - HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
        Returns:
        builder

      • operationName

        public MethodArgs.Builder operationName​(@Nullable
                                        com.pulumi.core.Output<java.lang.String> operationName)
        Parameters:
        operationName - Function name that will be given to the method when generating an SDK through API Gateway. If omitted, API Gateway will generate a function name based on the resource path and HTTP verb.
        Returns:
        builder

      • operationName

        public MethodArgs.Builder operationName​(java.lang.String operationName)
        Parameters:
        operationName - Function name that will be given to the method when generating an SDK through API Gateway. If omitted, API Gateway will generate a function name based on the resource path and HTTP verb.
        Returns:
        builder

      • region

        public MethodArgs.Builder region​(@Nullable
                                 com.pulumi.core.Output<java.lang.String> region)
        Parameters:
        region - Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
        Returns:
        builder

      • region

        public MethodArgs.Builder region​(java.lang.String region)
        Parameters:
        region - Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
        Returns:
        builder

      • requestModels

        public MethodArgs.Builder requestModels​(@Nullable
                                        com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> requestModels)
        Parameters:
        requestModels - Map of the API models used for the request's content type where key is the content type (e.g., `application/json`) and value is either `Error`, `Empty` (built-in models) or `aws.apigateway.Model`'s `name`.
        Returns:
        builder

      • requestModels

        public MethodArgs.Builder requestModels​(java.util.Map<java.lang.String,​java.lang.String> requestModels)
        Parameters:
        requestModels - Map of the API models used for the request's content type where key is the content type (e.g., `application/json`) and value is either `Error`, `Empty` (built-in models) or `aws.apigateway.Model`'s `name`.
        Returns:
        builder

      • requestParameters

        public MethodArgs.Builder requestParameters​(@Nullable
                                            com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.Boolean>> requestParameters)
        Parameters:
        requestParameters - Map of request parameters (from the path, query string and headers) that should be passed to the integration. The boolean value indicates whether the parameter is required (`true`) or optional (`false`). For example: `requestParameters = {"method.request.header.X-Some-Header" = true "method.request.querystring.some-query-param" = true}` would define that the header `X-Some-Header` and the query string `some-query-param` must be provided in the request.
        Returns:
        builder

      • requestParameters

        public MethodArgs.Builder requestParameters​(java.util.Map<java.lang.String,​java.lang.Boolean> requestParameters)
        Parameters:
        requestParameters - Map of request parameters (from the path, query string and headers) that should be passed to the integration. The boolean value indicates whether the parameter is required (`true`) or optional (`false`). For example: `requestParameters = {"method.request.header.X-Some-Header" = true "method.request.querystring.some-query-param" = true}` would define that the header `X-Some-Header` and the query string `some-query-param` must be provided in the request.
        Returns:
        builder

      • requestValidatorId

        public MethodArgs.Builder requestValidatorId​(@Nullable
                                             com.pulumi.core.Output<java.lang.String> requestValidatorId)
        Parameters:
        requestValidatorId - ID of a `aws.apigateway.RequestValidator`
        Returns:
        builder

      • requestValidatorId

        public MethodArgs.Builder requestValidatorId​(java.lang.String requestValidatorId)
        Parameters:
        requestValidatorId - ID of a `aws.apigateway.RequestValidator`
        Returns:
        builder

      • resourceId

        public MethodArgs.Builder resourceId​(com.pulumi.core.Output<java.lang.String> resourceId)
        Parameters:
        resourceId - API resource ID
        Returns:
        builder

      • resourceId

        public MethodArgs.Builder resourceId​(java.lang.String resourceId)
        Parameters:
        resourceId - API resource ID
        Returns:
        builder

      • restApi

        public MethodArgs.Builder restApi​(com.pulumi.core.Output<java.lang.String> restApi)
        Parameters:
        restApi - ID of the associated REST API
        Returns:
        builder

      • restApi

        public MethodArgs.Builder restApi​(java.lang.String restApi)
        Parameters:
        restApi - ID of the associated REST API
        Returns:
        builder