Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigateway
  5. Method

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.Method

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::ApiGateway::Method resource creates API Gateway methods that define the parameters and body that clients must send in their requests.

    Create Method Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Method(name: string, args: MethodArgs, opts?: CustomResourceOptions);
    @overload
def Method(resource_name: str,
           args: MethodArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Method(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           http_method: Optional[str] = None,
           rest_api_id: Optional[str] = None,
           resource_id: Optional[str] = None,
           method_responses: Optional[Sequence[MethodResponseArgs]] = None,
           authorizer_id: Optional[str] = None,
           integration: Optional[MethodIntegrationArgs] = None,
           api_key_required: Optional[bool] = None,
           operation_name: Optional[str] = None,
           request_models: Optional[Mapping[str, str]] = None,
           request_parameters: Optional[Mapping[str, Union[bool, str]]] = None,
           request_validator_id: Optional[str] = None,
           authorization_type: Optional[str] = None,
           authorization_scopes: Optional[Sequence[str]] = None)
    func NewMethod(ctx *Context, name string, args MethodArgs, opts ...ResourceOption) (*Method, error)
    public Method(string name, MethodArgs args, CustomResourceOptions? opts = null)
    public Method(String name, MethodArgs args)
public Method(String name, MethodArgs args, CustomResourceOptions options)

    type: aws-native:apigateway:Method
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args MethodArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args MethodArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args MethodArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MethodArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MethodArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Method Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Method resource accepts the following input properties:

    HttpMethod string
    The method's HTTP verb.
    ResourceId string
    The Resource identifier for the MethodResponse resource.
    RestApiId string
    The string identifier of the associated RestApi.
    ApiKeyRequired bool
    A boolean flag specifying whether a valid ApiKey is required to invoke this method.
    AuthorizationScopes List<string>
    A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
    AuthorizationType string
    The method's authorization type. This parameter is required. For valid values, see Method in the API Gateway API Reference. If you specify the AuthorizerId property, specify CUSTOM or COGNITO_USER_POOLS for this property.
    AuthorizerId string
    The identifier of an authorizer to use on this method. The method's authorization type must be CUSTOM or COGNITO_USER_POOLS .
    Integration Pulumi.AwsNative.ApiGateway.Inputs.MethodIntegration
    Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.
    MethodResponses List<Pulumi.AwsNative.ApiGateway.Inputs.MethodResponse>
    Gets a method response associated with a given HTTP status code.
    OperationName string
    A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
    RequestModels Dictionary<string, string>
    A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
    RequestParameters Dictionary<string, Union<bool, string>>
    A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( true ) or optional ( false ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
    RequestValidatorId string
    The identifier of a RequestValidator for request validation.
    HttpMethod string
    The method's HTTP verb.
    ResourceId string
    The Resource identifier for the MethodResponse resource.
    RestApiId string
    The string identifier of the associated RestApi.
    ApiKeyRequired bool
    A boolean flag specifying whether a valid ApiKey is required to invoke this method.
    AuthorizationScopes []string
    A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
    AuthorizationType string
    The method's authorization type. This parameter is required. For valid values, see Method in the API Gateway API Reference. If you specify the AuthorizerId property, specify CUSTOM or COGNITO_USER_POOLS for this property.
    AuthorizerId string
    The identifier of an authorizer to use on this method. The method's authorization type must be CUSTOM or COGNITO_USER_POOLS .
    Integration MethodIntegrationArgs
    Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.
    MethodResponses []MethodResponseArgs
    Gets a method response associated with a given HTTP status code.
    OperationName string
    A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
    RequestModels map[string]string
    A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
    RequestParameters map[string]interface{}
    A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( true ) or optional ( false ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
    RequestValidatorId string
    The identifier of a RequestValidator for request validation.
    httpMethod String
    The method's HTTP verb.
    resourceId String
    The Resource identifier for the MethodResponse resource.
    restApiId String
    The string identifier of the associated RestApi.
    apiKeyRequired Boolean
    A boolean flag specifying whether a valid ApiKey is required to invoke this method.
    authorizationScopes List<String>
    A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
    authorizationType String
    The method's authorization type. This parameter is required. For valid values, see Method in the API Gateway API Reference. If you specify the AuthorizerId property, specify CUSTOM or COGNITO_USER_POOLS for this property.
    authorizerId String
    The identifier of an authorizer to use on this method. The method's authorization type must be CUSTOM or COGNITO_USER_POOLS .
    integration MethodIntegration
    Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.
    methodResponses List<MethodResponse>
    Gets a method response associated with a given HTTP status code.
    operationName String
    A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
    requestModels Map<String,String>
    A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
    requestParameters Map<String,Either<Boolean,String>>
    A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( true ) or optional ( false ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
    requestValidatorId String
    The identifier of a RequestValidator for request validation.
    httpMethod string
    The method's HTTP verb.
    resourceId string
    The Resource identifier for the MethodResponse resource.
    restApiId string
    The string identifier of the associated RestApi.
    apiKeyRequired boolean
    A boolean flag specifying whether a valid ApiKey is required to invoke this method.
    authorizationScopes string[]
    A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
    authorizationType string
    The method's authorization type. This parameter is required. For valid values, see Method in the API Gateway API Reference. If you specify the AuthorizerId property, specify CUSTOM or COGNITO_USER_POOLS for this property.
    authorizerId string
    The identifier of an authorizer to use on this method. The method's authorization type must be CUSTOM or COGNITO_USER_POOLS .
    integration MethodIntegration
    Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.
    methodResponses MethodResponse[]
    Gets a method response associated with a given HTTP status code.
    operationName string
    A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
    requestModels {[key: string]: string}
    A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
    requestParameters {[key: string]: boolean | string}
    A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( true ) or optional ( false ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
    requestValidatorId string
    The identifier of a RequestValidator for request validation.
    http_method str
    The method's HTTP verb.
    resource_id str
    The Resource identifier for the MethodResponse resource.
    rest_api_id str
    The string identifier of the associated RestApi.
    api_key_required bool
    A boolean flag specifying whether a valid ApiKey is required to invoke this method.
    authorization_scopes Sequence[str]
    A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
    authorization_type str
    The method's authorization type. This parameter is required. For valid values, see Method in the API Gateway API Reference. If you specify the AuthorizerId property, specify CUSTOM or COGNITO_USER_POOLS for this property.
    authorizer_id str
    The identifier of an authorizer to use on this method. The method's authorization type must be CUSTOM or COGNITO_USER_POOLS .
    integration MethodIntegrationArgs
    Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.
    method_responses Sequence[MethodResponseArgs]
    Gets a method response associated with a given HTTP status code.
    operation_name str
    A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
    request_models Mapping[str, str]
    A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
    request_parameters Mapping[str, Union[bool, str]]
    A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( true ) or optional ( false ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
    request_validator_id str
    The identifier of a RequestValidator for request validation.
    httpMethod String
    The method's HTTP verb.
    resourceId String
    The Resource identifier for the MethodResponse resource.
    restApiId String
    The string identifier of the associated RestApi.
    apiKeyRequired Boolean
    A boolean flag specifying whether a valid ApiKey is required to invoke this method.
    authorizationScopes List<String>
    A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
    authorizationType String
    The method's authorization type. This parameter is required. For valid values, see Method in the API Gateway API Reference. If you specify the AuthorizerId property, specify CUSTOM or COGNITO_USER_POOLS for this property.
    authorizerId String
    The identifier of an authorizer to use on this method. The method's authorization type must be CUSTOM or COGNITO_USER_POOLS .
    integration Property Map
    Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.
    methodResponses List<Property Map>
    Gets a method response associated with a given HTTP status code.
    operationName String
    A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
    requestModels Map<String>
    A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
    requestParameters Map<Boolean | String>
    A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( true ) or optional ( false ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
    requestValidatorId String
    The identifier of a RequestValidator for request validation.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Method resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    MethodIntegration, MethodIntegrationArgs

    Type Pulumi.AwsNative.ApiGateway.MethodIntegrationType

    Specifies an API method integration type. The valid value is one of the following:

    For the HTTP and HTTP proxy integrations, each integration can specify a protocol ( http/https ), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

    CacheKeyParameters List<string>
    A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters , these parameters must also be specified for Method requestParameters .
    CacheNamespace string
    Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace . You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
    ConnectionId string
    The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
    ConnectionType Pulumi.AwsNative.ApiGateway.MethodIntegrationConnectionType
    The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET .
    ContentHandling Pulumi.AwsNative.ApiGateway.MethodIntegrationContentHandling

    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

    Credentials string
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\* . To use resource-based permissions on supported AWS services, specify null.
    IntegrationHttpMethod string
    Specifies the integration's HTTP method type. For the Type property, if you specify MOCK , this property is optional. For Lambda integrations, you must set the integration method to POST . For all other types, you must specify this property.
    IntegrationResponses List<Pulumi.AwsNative.ApiGateway.Inputs.MethodIntegrationResponse>
    Specifies the integration's responses.
    PassthroughBehavior Pulumi.AwsNative.ApiGateway.MethodIntegrationPassthroughBehavior
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates . The valid value is one of the following: WHEN_NO_MATCH : passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. WHEN_NO_TEMPLATES : passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER : rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    RequestParameters Dictionary<string, string>
    A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name must be a valid and unique method request parameter name.
    RequestTemplates Dictionary<string, string>
    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
    TimeoutInMillis int
    Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
    Uri string

    Specifies Uniform Resource Identifier (URI) of the integration endpoint.

    For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If connectionType is VPC_LINK specify the Network Load Balancer DNS name. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api} . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

    Type MethodIntegrationType

    Specifies an API method integration type. The valid value is one of the following:

    For the HTTP and HTTP proxy integrations, each integration can specify a protocol ( http/https ), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

    CacheKeyParameters []string
    A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters , these parameters must also be specified for Method requestParameters .
    CacheNamespace string
    Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace . You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
    ConnectionId string
    The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
    ConnectionType MethodIntegrationConnectionType
    The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET .
    ContentHandling MethodIntegrationContentHandling

    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

    Credentials string
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\* . To use resource-based permissions on supported AWS services, specify null.
    IntegrationHttpMethod string
    Specifies the integration's HTTP method type. For the Type property, if you specify MOCK , this property is optional. For Lambda integrations, you must set the integration method to POST . For all other types, you must specify this property.
    IntegrationResponses []MethodIntegrationResponse
    Specifies the integration's responses.
    PassthroughBehavior MethodIntegrationPassthroughBehavior
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates . The valid value is one of the following: WHEN_NO_MATCH : passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. WHEN_NO_TEMPLATES : passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER : rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    RequestParameters map[string]string
    A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name must be a valid and unique method request parameter name.
    RequestTemplates map[string]string
    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
    TimeoutInMillis int
    Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
    Uri string

    Specifies Uniform Resource Identifier (URI) of the integration endpoint.

    For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If connectionType is VPC_LINK specify the Network Load Balancer DNS name. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api} . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

    type MethodIntegrationType

    Specifies an API method integration type. The valid value is one of the following:

    For the HTTP and HTTP proxy integrations, each integration can specify a protocol ( http/https ), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

    cacheKeyParameters List<String>
    A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters , these parameters must also be specified for Method requestParameters .
    cacheNamespace String
    Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace . You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
    connectionId String
    The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
    connectionType MethodIntegrationConnectionType
    The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET .
    contentHandling MethodIntegrationContentHandling

    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

    credentials String
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\* . To use resource-based permissions on supported AWS services, specify null.
    integrationHttpMethod String
    Specifies the integration's HTTP method type. For the Type property, if you specify MOCK , this property is optional. For Lambda integrations, you must set the integration method to POST . For all other types, you must specify this property.
    integrationResponses List<MethodIntegrationResponse>
    Specifies the integration's responses.
    passthroughBehavior MethodIntegrationPassthroughBehavior
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates . The valid value is one of the following: WHEN_NO_MATCH : passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. WHEN_NO_TEMPLATES : passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER : rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    requestParameters Map<String,String>
    A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name must be a valid and unique method request parameter name.
    requestTemplates Map<String,String>
    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
    timeoutInMillis Integer
    Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
    uri String

    Specifies Uniform Resource Identifier (URI) of the integration endpoint.

    For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If connectionType is VPC_LINK specify the Network Load Balancer DNS name. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api} . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

    type MethodIntegrationType

    Specifies an API method integration type. The valid value is one of the following:

    For the HTTP and HTTP proxy integrations, each integration can specify a protocol ( http/https ), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

    cacheKeyParameters string[]
    A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters , these parameters must also be specified for Method requestParameters .
    cacheNamespace string
    Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace . You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
    connectionId string
    The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
    connectionType MethodIntegrationConnectionType
    The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET .
    contentHandling MethodIntegrationContentHandling

    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

    credentials string
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\* . To use resource-based permissions on supported AWS services, specify null.
    integrationHttpMethod string
    Specifies the integration's HTTP method type. For the Type property, if you specify MOCK , this property is optional. For Lambda integrations, you must set the integration method to POST . For all other types, you must specify this property.
    integrationResponses MethodIntegrationResponse[]
    Specifies the integration's responses.
    passthroughBehavior MethodIntegrationPassthroughBehavior
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates . The valid value is one of the following: WHEN_NO_MATCH : passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. WHEN_NO_TEMPLATES : passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER : rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    requestParameters {[key: string]: string}
    A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name must be a valid and unique method request parameter name.
    requestTemplates {[key: string]: string}
    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
    timeoutInMillis number
    Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
    uri string

    Specifies Uniform Resource Identifier (URI) of the integration endpoint.

    For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If connectionType is VPC_LINK specify the Network Load Balancer DNS name. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api} . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

    type MethodIntegrationType

    Specifies an API method integration type. The valid value is one of the following:

    For the HTTP and HTTP proxy integrations, each integration can specify a protocol ( http/https ), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

    cache_key_parameters Sequence[str]
    A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters , these parameters must also be specified for Method requestParameters .
    cache_namespace str
    Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace . You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
    connection_id str
    The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
    connection_type MethodIntegrationConnectionType
    The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET .
    content_handling MethodIntegrationContentHandling

    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

    credentials str
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\* . To use resource-based permissions on supported AWS services, specify null.
    integration_http_method str
    Specifies the integration's HTTP method type. For the Type property, if you specify MOCK , this property is optional. For Lambda integrations, you must set the integration method to POST . For all other types, you must specify this property.
    integration_responses Sequence[MethodIntegrationResponse]
    Specifies the integration's responses.
    passthrough_behavior MethodIntegrationPassthroughBehavior
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates . The valid value is one of the following: WHEN_NO_MATCH : passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. WHEN_NO_TEMPLATES : passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER : rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    request_parameters Mapping[str, str]
    A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name must be a valid and unique method request parameter name.
    request_templates Mapping[str, str]
    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
    timeout_in_millis int
    Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
    uri str

    Specifies Uniform Resource Identifier (URI) of the integration endpoint.

    For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If connectionType is VPC_LINK specify the Network Load Balancer DNS name. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api} . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

    type "AWS" | "AWS_PROXY" | "HTTP" | "HTTP_PROXY" | "MOCK"

    Specifies an API method integration type. The valid value is one of the following:

    For the HTTP and HTTP proxy integrations, each integration can specify a protocol ( http/https ), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

    cacheKeyParameters List<String>
    A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters , these parameters must also be specified for Method requestParameters .
    cacheNamespace String
    Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace . You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
    connectionId String
    The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
    connectionType "INTERNET" | "VPC_LINK"
    The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET .
    contentHandling "CONVERT_TO_BINARY" | "CONVERT_TO_TEXT"

    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

    credentials String
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\* . To use resource-based permissions on supported AWS services, specify null.
    integrationHttpMethod String
    Specifies the integration's HTTP method type. For the Type property, if you specify MOCK , this property is optional. For Lambda integrations, you must set the integration method to POST . For all other types, you must specify this property.
    integrationResponses List<Property Map>
    Specifies the integration's responses.
    passthroughBehavior "WHEN_NO_MATCH" | "WHEN_NO_TEMPLATES" | "NEVER"
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates . The valid value is one of the following: WHEN_NO_MATCH : passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. WHEN_NO_TEMPLATES : passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER : rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    requestParameters Map<String>
    A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name must be a valid and unique method request parameter name.
    requestTemplates Map<String>
    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
    timeoutInMillis Number
    Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
    uri String

    Specifies Uniform Resource Identifier (URI) of the integration endpoint.

    For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If connectionType is VPC_LINK specify the Network Load Balancer DNS name. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api} . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

    MethodIntegrationConnectionType, MethodIntegrationConnectionTypeArgs

    Internet
    INTERNET
    VpcLink
    VPC_LINK
    MethodIntegrationConnectionTypeInternet
    INTERNET
    MethodIntegrationConnectionTypeVpcLink
    VPC_LINK
    Internet
    INTERNET
    VpcLink
    VPC_LINK
    Internet
    INTERNET
    VpcLink
    VPC_LINK
    INTERNET
    INTERNET
    VPC_LINK
    VPC_LINK
    "INTERNET"
    INTERNET
    "VPC_LINK"
    VPC_LINK

    MethodIntegrationContentHandling, MethodIntegrationContentHandlingArgs

    ConvertToBinary
    CONVERT_TO_BINARY
    ConvertToText
    CONVERT_TO_TEXT
    MethodIntegrationContentHandlingConvertToBinary
    CONVERT_TO_BINARY
    MethodIntegrationContentHandlingConvertToText
    CONVERT_TO_TEXT
    ConvertToBinary
    CONVERT_TO_BINARY
    ConvertToText
    CONVERT_TO_TEXT
    ConvertToBinary
    CONVERT_TO_BINARY
    ConvertToText
    CONVERT_TO_TEXT
    CONVERT_TO_BINARY
    CONVERT_TO_BINARY
    CONVERT_TO_TEXT
    CONVERT_TO_TEXT
    "CONVERT_TO_BINARY"
    CONVERT_TO_BINARY
    "CONVERT_TO_TEXT"
    CONVERT_TO_TEXT

    MethodIntegrationPassthroughBehavior, MethodIntegrationPassthroughBehaviorArgs

    WhenNoMatch
    WHEN_NO_MATCH
    WhenNoTemplates
    WHEN_NO_TEMPLATES
    Never
    NEVER
    MethodIntegrationPassthroughBehaviorWhenNoMatch
    WHEN_NO_MATCH
    MethodIntegrationPassthroughBehaviorWhenNoTemplates
    WHEN_NO_TEMPLATES
    MethodIntegrationPassthroughBehaviorNever
    NEVER
    WhenNoMatch
    WHEN_NO_MATCH
    WhenNoTemplates
    WHEN_NO_TEMPLATES
    Never
    NEVER
    WhenNoMatch
    WHEN_NO_MATCH
    WhenNoTemplates
    WHEN_NO_TEMPLATES
    Never
    NEVER
    WHEN_NO_MATCH
    WHEN_NO_MATCH
    WHEN_NO_TEMPLATES
    WHEN_NO_TEMPLATES
    NEVER
    NEVER
    "WHEN_NO_MATCH"
    WHEN_NO_MATCH
    "WHEN_NO_TEMPLATES"
    WHEN_NO_TEMPLATES
    "NEVER"
    NEVER

    MethodIntegrationResponse, MethodIntegrationResponseArgs

    StatusCode string
    Specifies the status code that is used to map the integration response to an existing MethodResponse.
    ContentHandling Pulumi.AwsNative.ApiGateway.MethodIntegrationResponseContentHandling

    Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

    If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

    ResponseParameters Dictionary<string, string>
    A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
    ResponseTemplates Dictionary<string, string>
    Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
    SelectionPattern string
    Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline ( \n ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
    StatusCode string
    Specifies the status code that is used to map the integration response to an existing MethodResponse.
    ContentHandling MethodIntegrationResponseContentHandling

    Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

    If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

    ResponseParameters map[string]string
    A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
    ResponseTemplates map[string]string
    Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
    SelectionPattern string
    Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline ( \n ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
    statusCode String
    Specifies the status code that is used to map the integration response to an existing MethodResponse.
    contentHandling MethodIntegrationResponseContentHandling

    Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

    If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

    responseParameters Map<String,String>
    A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
    responseTemplates Map<String,String>
    Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
    selectionPattern String
    Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline ( \n ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
    statusCode string
    Specifies the status code that is used to map the integration response to an existing MethodResponse.
    contentHandling MethodIntegrationResponseContentHandling

    Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

    If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

    responseParameters {[key: string]: string}
    A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
    responseTemplates {[key: string]: string}
    Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
    selectionPattern string
    Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline ( \n ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
    status_code str
    Specifies the status code that is used to map the integration response to an existing MethodResponse.
    content_handling MethodIntegrationResponseContentHandling

    Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

    If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

    response_parameters Mapping[str, str]
    A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
    response_templates Mapping[str, str]
    Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
    selection_pattern str
    Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline ( \n ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
    statusCode String
    Specifies the status code that is used to map the integration response to an existing MethodResponse.
    contentHandling "CONVERT_TO_BINARY" | "CONVERT_TO_TEXT"

    Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

    If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

    responseParameters Map<String>
    A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
    responseTemplates Map<String>
    Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
    selectionPattern String
    Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline ( \n ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

    MethodIntegrationResponseContentHandling, MethodIntegrationResponseContentHandlingArgs

    ConvertToBinary
    CONVERT_TO_BINARY
    ConvertToText
    CONVERT_TO_TEXT
    MethodIntegrationResponseContentHandlingConvertToBinary
    CONVERT_TO_BINARY
    MethodIntegrationResponseContentHandlingConvertToText
    CONVERT_TO_TEXT
    ConvertToBinary
    CONVERT_TO_BINARY
    ConvertToText
    CONVERT_TO_TEXT
    ConvertToBinary
    CONVERT_TO_BINARY
    ConvertToText
    CONVERT_TO_TEXT
    CONVERT_TO_BINARY
    CONVERT_TO_BINARY
    CONVERT_TO_TEXT
    CONVERT_TO_TEXT
    "CONVERT_TO_BINARY"
    CONVERT_TO_BINARY
    "CONVERT_TO_TEXT"
    CONVERT_TO_TEXT

    MethodIntegrationType, MethodIntegrationTypeArgs

    Aws
    AWS
    AwsProxy
    AWS_PROXY
    Http
    HTTP
    HttpProxy
    HTTP_PROXY
    Mock
    MOCK
    MethodIntegrationTypeAws
    AWS
    MethodIntegrationTypeAwsProxy
    AWS_PROXY
    MethodIntegrationTypeHttp
    HTTP
    MethodIntegrationTypeHttpProxy
    HTTP_PROXY
    MethodIntegrationTypeMock
    MOCK
    Aws
    AWS
    AwsProxy
    AWS_PROXY
    Http
    HTTP
    HttpProxy
    HTTP_PROXY
    Mock
    MOCK
    Aws
    AWS
    AwsProxy
    AWS_PROXY
    Http
    HTTP
    HttpProxy
    HTTP_PROXY
    Mock
    MOCK
    AWS
    AWS
    AWS_PROXY
    AWS_PROXY
    HTTP
    HTTP
    HTTP_PROXY
    HTTP_PROXY
    MOCK
    MOCK
    "AWS"
    AWS
    "AWS_PROXY"
    AWS_PROXY
    "HTTP"
    HTTP
    "HTTP_PROXY"
    HTTP_PROXY
    "MOCK"
    MOCK

    MethodResponse, MethodResponseArgs

    StatusCode string
    The method response's status code.
    ResponseModels Dictionary<string, string>
    Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
    ResponseParameters Dictionary<string, Union<bool, string>>
    A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name} , where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name} , a static value enclosed within a pair of single quotes (e.g., 'application/json' ), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression} , where JSON-expression is a valid JSON expression without the $ prefix.)
    StatusCode string
    The method response's status code.
    ResponseModels map[string]string
    Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
    ResponseParameters map[string]interface{}
    A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name} , where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name} , a static value enclosed within a pair of single quotes (e.g., 'application/json' ), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression} , where JSON-expression is a valid JSON expression without the $ prefix.)
    statusCode String
    The method response's status code.
    responseModels Map<String,String>
    Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
    responseParameters Map<String,Either<Boolean,String>>
    A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name} , where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name} , a static value enclosed within a pair of single quotes (e.g., 'application/json' ), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression} , where JSON-expression is a valid JSON expression without the $ prefix.)
    statusCode string
    The method response's status code.
    responseModels {[key: string]: string}
    Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
    responseParameters {[key: string]: boolean | string}
    A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name} , where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name} , a static value enclosed within a pair of single quotes (e.g., 'application/json' ), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression} , where JSON-expression is a valid JSON expression without the $ prefix.)
    status_code str
    The method response's status code.
    response_models Mapping[str, str]
    Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
    response_parameters Mapping[str, Union[bool, str]]
    A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name} , where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name} , a static value enclosed within a pair of single quotes (e.g., 'application/json' ), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression} , where JSON-expression is a valid JSON expression without the $ prefix.)
    statusCode String
    The method response's status code.
    responseModels Map<String>
    Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
    responseParameters Map<Boolean | String>
    A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name} , where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name} , a static value enclosed within a pair of single quotes (e.g., 'application/json' ), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression} , where JSON-expression is a valid JSON expression without the $ prefix.)

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native