The AWS::ApiGateway::Method
resource creates API Gateway methods that define the parameters and body that clients must send in their requests.
Creates a mock method GET
resource "awscc_apigateway_rest_api" "example" {
name = "ExampleAPI"
}
resource "awscc_apigateway_resource" "example" {
rest_api_id = awscc_apigateway_rest_api.example.id
parent_id = awscc_apigateway_rest_api.example.root_resource_id
path_part = "path"
}
resource "awscc_apigateway_method" "example" {
rest_api_id = awscc_apigateway_rest_api.example.id
resource_id = awscc_apigateway_resource.example.resource_id
http_method = "GET"
authorization_type = "NONE"
integration = {
type = "MOCK"
request_templates = {
"application/json" = jsonencode({
"statusCode" : 200
})
}
integration_responses = [{
status_code = "200"
response_templates = {
"application/json" = jsonencode({
"ip" : "$context.identity.sourceIp",
"userAgent" : "$context.identity.userAgent",
"time" : "$context.requestTime",
"epochTime" : "$context.requestTimeEpoch"
})
}
}]
}
method_responses = [{
status_code = "200"
}]
}
Basic use of API method response with only status code
resource "awscc_apigateway_rest_api" "terraform_apigateway_rest_api" {
name = "TestRestApi"
endpoint_configuration = {
types = [
"REGIONAL"
]
}
}
resource "awscc_apigateway_method" "terraform_apigateway_method" {
http_method = "GET"
authorization_type = "NONE"
integration = {
type = "MOCK"
}
rest_api_id = awscc_apigateway_rest_api.terraform_apigateway_rest_api.id
resource_id = awscc_apigateway_rest_api.terraform_apigateway_rest_api.root_resource_id
method_responses = [{ status_code = "200" }]
depends_on = [awscc_apigateway_rest_api.terraform_apigateway_rest_api]
}
API method response using response models and response parameters
resource "awscc_apigateway_rest_api" "terraform_apigateway_rest_api" {
name = "TestRestApi"
endpoint_configuration = {
types = [
"REGIONAL"
]
}
}
resource "awscc_apigateway_method" "terraform_apigateway_method" {
http_method = "GET"
authorization_type = "NONE"
integration = {
type = "MOCK"
}
rest_api_id = awscc_apigateway_rest_api.terraform_apigateway_rest_api.id
resource_id = awscc_apigateway_rest_api.terraform_apigateway_rest_api.root_resource_id
method_responses = [{ status_code = "200", response_models = { "application/json": "Empty"} , response_parameters = {"method.response.header.Content-Type" = false}}]
depends_on = [awscc_apigateway_rest_api.terraform_apigateway_rest_api]
}
http_method
(String) The method's HTTP verb.resource_id
(String) The Resource identifier for the MethodResponse resource.rest_api_id
(String) The string identifier of the associated RestApi.api_key_required
(Boolean) A boolean flag specifying whether a valid ApiKey is required to invoke this method.authorization_scopes
(List of 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.authorization_type
(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.authorizer_id
(String) The identifier of an authorizer to use on this method. The method's authorization type must be CUSTOM
or COGNITO_USER_POOLS
.integration
(Attributes) Represents an HTTP
, HTTP_PROXY
, AWS
, AWS_PROXY
, or Mock integration. (see below for nested schema)method_responses
(Attributes List) Gets a method response associated with a given HTTP status code. (see below for nested schema)operation_name
(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.request_models
(Map of 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).request_parameters
(Map of Boolean) 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
(String) The identifier of a RequestValidator for request validation.id
(String) Uniquely identifies the resource.integration
Required:
type
(String) 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.Optional:
cache_key_parameters
(List of 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
.cache_namespace
(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.connection_id
(String) The ID of the VpcLink used for the integration when connectionType=VPC_LINK
and undefined, otherwise.connection_type
(String) 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
(String) 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.integration_http_method
(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.integration_responses
(Attributes List) Specifies the integration's responses. (see below for nested schema)passthrough_behavior
(String) 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
(Map of 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.request_templates
(Map of 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.timeout_in_millis
(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}
integration.integration_responses
Required:
status_code
(String) Specifies the status code that is used to map the integration response to an existing MethodResponse.Optional:
content_handling
(String) 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
(Map of 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.response_templates
(Map of 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.selection_pattern
(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 LAMlong function, the LAMlong function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.method_responses
Required:
status_code
(String) The method response's status code.Optional:
response_models
(Map of 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.response_parameters
(Map of Boolean) 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.)Import is supported using the following syntax:
$ terraform import awscc_apigateway_method.example <resource ID>