AWS Native v0.63.0, May 25 23

aws-native.apigateway.Method

Explore with Pulumi AI

Resource Type definition for AWS::ApiGateway::Method

Create Method Resource

new Method(name: string, args: MethodArgs, opts?: CustomResourceOptions);

@overload
def Method(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           api_key_required: Optional[bool] = None,
           authorization_scopes: Optional[Sequence[str]] = None,
           authorization_type: Optional[MethodAuthorizationType] = None,
           authorizer_id: Optional[str] = None,
           http_method: Optional[str] = None,
           integration: Optional[MethodIntegrationArgs] = None,
           method_responses: Optional[Sequence[MethodResponseArgs]] = None,
           operation_name: Optional[str] = None,
           request_models: Optional[Any] = None,
           request_parameters: Optional[Any] = None,
           request_validator_id: Optional[str] = None,
           resource_id: Optional[str] = None,
           rest_api_id: Optional[str] = None)
@overload
def Method(resource_name: str,
           args: MethodArgs,
           opts: Optional[ResourceOptions] = 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.

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

The Method resource accepts the following input properties:

HttpMethod string: The backend system that the method calls when it receives a request.
ResourceId string: The ID of an API Gateway resource.
RestApiId string: The ID of the RestApi resource in which API Gateway creates the method.
ApiKeyRequired bool: Indicates whether the method requires clients to submit a valid API key.
AuthorizationScopes List<string>: A list of authorization scopes configured on the method.
AuthorizationType Pulumi.AwsNative.ApiGateway.MethodAuthorizationType: The method's authorization type.
AuthorizerId string: The identifier of the authorizer to use on this method.
Integration Pulumi.AwsNative.ApiGateway.Inputs.MethodIntegrationArgs: The backend system that the method calls when it receives a request.
MethodResponses List<Pulumi.AwsNative.ApiGateway.Inputs.MethodResponseArgs>: The responses that can be sent to the client who calls the method.
OperationName string: A friendly operation name for the method.
RequestModels object: The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.
RequestParameters object: The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.
RequestValidatorId string: The ID of the associated request validator.

HttpMethod string: The backend system that the method calls when it receives a request.
ResourceId string: The ID of an API Gateway resource.
RestApiId string: The ID of the RestApi resource in which API Gateway creates the method.
ApiKeyRequired bool: Indicates whether the method requires clients to submit a valid API key.
AuthorizationScopes []string: A list of authorization scopes configured on the method.
AuthorizationType MethodAuthorizationType: The method's authorization type.
AuthorizerId string: The identifier of the authorizer to use on this method.
Integration MethodIntegrationArgs: The backend system that the method calls when it receives a request.
MethodResponses []MethodResponseArgs: The responses that can be sent to the client who calls the method.
OperationName string: A friendly operation name for the method.
RequestModels interface{}: The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.
RequestParameters interface{}: The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.
RequestValidatorId string: The ID of the associated request validator.

httpMethod String: The backend system that the method calls when it receives a request.
resourceId String: The ID of an API Gateway resource.
restApiId String: The ID of the RestApi resource in which API Gateway creates the method.
apiKeyRequired Boolean: Indicates whether the method requires clients to submit a valid API key.
authorizationScopes List<String>: A list of authorization scopes configured on the method.
authorizationType MethodAuthorizationType: The method's authorization type.
authorizerId String: The identifier of the authorizer to use on this method.
integration MethodIntegrationArgs: The backend system that the method calls when it receives a request.
methodResponses List<MethodResponseArgs>: The responses that can be sent to the client who calls the method.
operationName String: A friendly operation name for the method.
requestModels Object: The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.
requestParameters Object: The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.
requestValidatorId String: The ID of the associated request validator.

httpMethod string: The backend system that the method calls when it receives a request.
resourceId string: The ID of an API Gateway resource.
restApiId string: The ID of the RestApi resource in which API Gateway creates the method.
apiKeyRequired boolean: Indicates whether the method requires clients to submit a valid API key.
authorizationScopes string[]: A list of authorization scopes configured on the method.
authorizationType MethodAuthorizationType: The method's authorization type.
authorizerId string: The identifier of the authorizer to use on this method.
integration MethodIntegrationArgs: The backend system that the method calls when it receives a request.
methodResponses MethodResponseArgs[]: The responses that can be sent to the client who calls the method.
operationName string: A friendly operation name for the method.
requestModels any: The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.
requestParameters any: The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.
requestValidatorId string: The ID of the associated request validator.

http_method str: The backend system that the method calls when it receives a request.
resource_id str: The ID of an API Gateway resource.
rest_api_id str: The ID of the RestApi resource in which API Gateway creates the method.
api_key_required bool: Indicates whether the method requires clients to submit a valid API key.
authorization_scopes Sequence[str]: A list of authorization scopes configured on the method.
authorization_type MethodAuthorizationType: The method's authorization type.
authorizer_id str: The identifier of the authorizer to use on this method.
integration MethodIntegrationArgs: The backend system that the method calls when it receives a request.
method_responses Sequence[MethodResponseArgs]: The responses that can be sent to the client who calls the method.
operation_name str: A friendly operation name for the method.
request_models Any: The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.
request_parameters Any: The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.
request_validator_id str: The ID of the associated request validator.

httpMethod String: The backend system that the method calls when it receives a request.
resourceId String: The ID of an API Gateway resource.
restApiId String: The ID of the RestApi resource in which API Gateway creates the method.
apiKeyRequired Boolean: Indicates whether the method requires clients to submit a valid API key.
authorizationScopes List<String>: A list of authorization scopes configured on the method.
authorizationType "NONE" | "AWS_IAM" | "CUSTOM" | "COGNITO_USER_POOLS": The method's authorization type.
authorizerId String: The identifier of the authorizer to use on this method.
integration Property Map: The backend system that the method calls when it receives a request.
methodResponses List<Property Map>: The responses that can be sent to the client who calls the method.
operationName String: A friendly operation name for the method.
requestModels Any: The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.
requestParameters Any: The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.
requestValidatorId String: The ID of the associated request validator.

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

MethodAuthorizationType

None: NONE
AwsIam: AWS_IAM
Custom: CUSTOM
CognitoUserPools: COGNITO_USER_POOLS

MethodAuthorizationTypeNone: NONE
MethodAuthorizationTypeAwsIam: AWS_IAM
MethodAuthorizationTypeCustom: CUSTOM
MethodAuthorizationTypeCognitoUserPools: COGNITO_USER_POOLS

None: NONE
AwsIam: AWS_IAM
Custom: CUSTOM
CognitoUserPools: COGNITO_USER_POOLS

None: NONE
AwsIam: AWS_IAM
Custom: CUSTOM
CognitoUserPools: COGNITO_USER_POOLS

NONE: NONE
AWS_IAM: AWS_IAM
CUSTOM: CUSTOM
COGNITO_USER_POOLS: COGNITO_USER_POOLS

"NONE": NONE
"AWS_IAM": AWS_IAM
"CUSTOM": CUSTOM
"COGNITO_USER_POOLS": COGNITO_USER_POOLS

MethodIntegration

Type Pulumi.AwsNative.ApiGateway.MethodIntegrationType: The type of backend that your method is running.
CacheKeyParameters List<string>: A list of request parameters whose values API Gateway caches.
CacheNamespace string: An API-specific tag group of related cached parameters.
ConnectionId string: The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined.
ConnectionType Pulumi.AwsNative.ApiGateway.MethodIntegrationConnectionType: The type of the network connection to the integration endpoint.
ContentHandling Pulumi.AwsNative.ApiGateway.MethodIntegrationContentHandling: Specifies how to handle request payload content type conversions.
Credentials string: The credentials that are required for the integration.
IntegrationHttpMethod string: The integration's HTTP method type.
IntegrationResponses List<Pulumi.AwsNative.ApiGateway.Inputs.MethodIntegrationResponse>: The response that API Gateway provides after a method's backend completes processing a request.
PassthroughBehavior Pulumi.AwsNative.ApiGateway.MethodIntegrationPassthroughBehavior: Indicates when API Gateway passes requests to the targeted backend.
RequestParameters object: The request parameters that API Gateway sends with the backend request.
RequestTemplates object: A map of Apache Velocity templates that are applied on the request payload.
TimeoutInMillis int: Custom timeout between 50 and 29,000 milliseconds.
Uri string: The Uniform Resource Identifier (URI) for the integration.

Type MethodIntegrationType: The type of backend that your method is running.
CacheKeyParameters []string: A list of request parameters whose values API Gateway caches.
CacheNamespace string: An API-specific tag group of related cached parameters.
ConnectionId string: The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined.
ConnectionType MethodIntegrationConnectionType: The type of the network connection to the integration endpoint.
ContentHandling MethodIntegrationContentHandling: Specifies how to handle request payload content type conversions.
Credentials string: The credentials that are required for the integration.
IntegrationHttpMethod string: The integration's HTTP method type.
IntegrationResponses []MethodIntegrationResponse: The response that API Gateway provides after a method's backend completes processing a request.
PassthroughBehavior MethodIntegrationPassthroughBehavior: Indicates when API Gateway passes requests to the targeted backend.
RequestParameters interface{}: The request parameters that API Gateway sends with the backend request.
RequestTemplates interface{}: A map of Apache Velocity templates that are applied on the request payload.
TimeoutInMillis int: Custom timeout between 50 and 29,000 milliseconds.
Uri string: The Uniform Resource Identifier (URI) for the integration.

type MethodIntegrationType: The type of backend that your method is running.
cacheKeyParameters List<String>: A list of request parameters whose values API Gateway caches.
cacheNamespace String: An API-specific tag group of related cached parameters.
connectionId String: The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined.
connectionType MethodIntegrationConnectionType: The type of the network connection to the integration endpoint.
contentHandling MethodIntegrationContentHandling: Specifies how to handle request payload content type conversions.
credentials String: The credentials that are required for the integration.
integrationHttpMethod String: The integration's HTTP method type.
integrationResponses List<MethodIntegrationResponse>: The response that API Gateway provides after a method's backend completes processing a request.
passthroughBehavior MethodIntegrationPassthroughBehavior: Indicates when API Gateway passes requests to the targeted backend.
requestParameters Object: The request parameters that API Gateway sends with the backend request.
requestTemplates Object: A map of Apache Velocity templates that are applied on the request payload.
timeoutInMillis Integer: Custom timeout between 50 and 29,000 milliseconds.
uri String: The Uniform Resource Identifier (URI) for the integration.

type MethodIntegrationType: The type of backend that your method is running.
cacheKeyParameters string[]: A list of request parameters whose values API Gateway caches.
cacheNamespace string: An API-specific tag group of related cached parameters.
connectionId string: The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined.
connectionType MethodIntegrationConnectionType: The type of the network connection to the integration endpoint.
contentHandling MethodIntegrationContentHandling: Specifies how to handle request payload content type conversions.
credentials string: The credentials that are required for the integration.
integrationHttpMethod string: The integration's HTTP method type.
integrationResponses MethodIntegrationResponse[]: The response that API Gateway provides after a method's backend completes processing a request.
passthroughBehavior MethodIntegrationPassthroughBehavior: Indicates when API Gateway passes requests to the targeted backend.
requestParameters any: The request parameters that API Gateway sends with the backend request.
requestTemplates any: A map of Apache Velocity templates that are applied on the request payload.
timeoutInMillis number: Custom timeout between 50 and 29,000 milliseconds.
uri string: The Uniform Resource Identifier (URI) for the integration.

type MethodIntegrationType: The type of backend that your method is running.
cache_key_parameters Sequence[str]: A list of request parameters whose values API Gateway caches.
cache_namespace str: An API-specific tag group of related cached parameters.
connection_id str: The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined.
connection_type MethodIntegrationConnectionType: The type of the network connection to the integration endpoint.
content_handling MethodIntegrationContentHandling: Specifies how to handle request payload content type conversions.
credentials str: The credentials that are required for the integration.
integration_http_method str: The integration's HTTP method type.
integration_responses Sequence[MethodIntegrationResponse]: The response that API Gateway provides after a method's backend completes processing a request.
passthrough_behavior MethodIntegrationPassthroughBehavior: Indicates when API Gateway passes requests to the targeted backend.
request_parameters Any: The request parameters that API Gateway sends with the backend request.
request_templates Any: A map of Apache Velocity templates that are applied on the request payload.
timeout_in_millis int: Custom timeout between 50 and 29,000 milliseconds.
uri str: The Uniform Resource Identifier (URI) for the integration.

type "AWS" | "AWS_PROXY" | "HTTP" | "HTTP_PROXY" | "MOCK": The type of backend that your method is running.
cacheKeyParameters List<String>: A list of request parameters whose values API Gateway caches.
cacheNamespace String: An API-specific tag group of related cached parameters.
connectionId String: The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined.
connectionType "INTERNET" | "VPC_LINK": The type of the network connection to the integration endpoint.
contentHandling "CONVERT_TO_BINARY" | "CONVERT_TO_TEXT": Specifies how to handle request payload content type conversions.
credentials String: The credentials that are required for the integration.
integrationHttpMethod String: The integration's HTTP method type.
integrationResponses List<Property Map>: The response that API Gateway provides after a method's backend completes processing a request.
passthroughBehavior "WHEN_NO_MATCH" | "WHEN_NO_TEMPLATES" | "NEVER": Indicates when API Gateway passes requests to the targeted backend.
requestParameters Any: The request parameters that API Gateway sends with the backend request.
requestTemplates Any: A map of Apache Velocity templates that are applied on the request payload.
timeoutInMillis Number: Custom timeout between 50 and 29,000 milliseconds.
uri String: The Uniform Resource Identifier (URI) for the integration.

MethodIntegrationConnectionType

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

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

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

StatusCode string: The status code that API Gateway uses to map the integration response to a MethodResponse status code.
ContentHandling Pulumi.AwsNative.ApiGateway.MethodIntegrationResponseContentHandling: Specifies how to handle request payload content type conversions.
ResponseParameters object: The response parameters from the backend response that API Gateway sends to the method response.
ResponseTemplates object: The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value.
SelectionPattern string: A regular expression that specifies which error strings or status codes from the backend map to the integration response.

StatusCode string: The status code that API Gateway uses to map the integration response to a MethodResponse status code.
ContentHandling MethodIntegrationResponseContentHandling: Specifies how to handle request payload content type conversions.
ResponseParameters interface{}: The response parameters from the backend response that API Gateway sends to the method response.
ResponseTemplates interface{}: The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value.
SelectionPattern string: A regular expression that specifies which error strings or status codes from the backend map to the integration response.

statusCode String: The status code that API Gateway uses to map the integration response to a MethodResponse status code.
contentHandling MethodIntegrationResponseContentHandling: Specifies how to handle request payload content type conversions.
responseParameters Object: The response parameters from the backend response that API Gateway sends to the method response.
responseTemplates Object: The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value.
selectionPattern String: A regular expression that specifies which error strings or status codes from the backend map to the integration response.

statusCode string: The status code that API Gateway uses to map the integration response to a MethodResponse status code.
contentHandling MethodIntegrationResponseContentHandling: Specifies how to handle request payload content type conversions.
responseParameters any: The response parameters from the backend response that API Gateway sends to the method response.
responseTemplates any: The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value.
selectionPattern string: A regular expression that specifies which error strings or status codes from the backend map to the integration response.

status_code str: The status code that API Gateway uses to map the integration response to a MethodResponse status code.
content_handling MethodIntegrationResponseContentHandling: Specifies how to handle request payload content type conversions.
response_parameters Any: The response parameters from the backend response that API Gateway sends to the method response.
response_templates Any: The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value.
selection_pattern str: A regular expression that specifies which error strings or status codes from the backend map to the integration response.

statusCode String: The status code that API Gateway uses to map the integration response to a MethodResponse status code.
contentHandling "CONVERT_TO_BINARY" | "CONVERT_TO_TEXT": Specifies how to handle request payload content type conversions.
responseParameters Any: The response parameters from the backend response that API Gateway sends to the method response.
responseTemplates Any: The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value.
selectionPattern String: A regular expression that specifies which error strings or status codes from the backend map to the integration response.

MethodIntegrationResponseContentHandling

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

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

StatusCode string: The method response's status code, which you map to an IntegrationResponse.
ResponseModels object: The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.
ResponseParameters object: Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value.

StatusCode string: The method response's status code, which you map to an IntegrationResponse.
ResponseModels interface{}: The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.
ResponseParameters interface{}: Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value.

statusCode String: The method response's status code, which you map to an IntegrationResponse.
responseModels Object: The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.
responseParameters Object: Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value.

statusCode string: The method response's status code, which you map to an IntegrationResponse.
responseModels any: The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.
responseParameters any: Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value.

status_code str: The method response's status code, which you map to an IntegrationResponse.
response_models Any: The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.
response_parameters Any: Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value.

statusCode String: The method response's status code, which you map to an IntegrationResponse.
responseModels Any: The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.
responseParameters Any: Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value.

Package Details

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