Interface CfnMethod.IntegrationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnMethod.IntegrationProperty.Jsii$Proxy
- Enclosing class:
CfnMethod
Integration
is a property of the AWS::ApiGateway::Method resource that specifies information about the target backend that a method calls.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.apigateway.*; IntegrationProperty integrationProperty = IntegrationProperty.builder() .cacheKeyParameters(List.of("cacheKeyParameters")) .cacheNamespace("cacheNamespace") .connectionId("connectionId") .connectionType("connectionType") .contentHandling("contentHandling") .credentials("credentials") .integrationHttpMethod("integrationHttpMethod") .integrationResponses(List.of(IntegrationResponseProperty.builder() .statusCode("statusCode") // the properties below are optional .contentHandling("contentHandling") .responseParameters(Map.of( "responseParametersKey", "responseParameters")) .responseTemplates(Map.of( "responseTemplatesKey", "responseTemplates")) .selectionPattern("selectionPattern") .build())) .passthroughBehavior("passthroughBehavior") .requestParameters(Map.of( "requestParametersKey", "requestParameters")) .requestTemplates(Map.of( "requestTemplatesKey", "requestTemplates")) .timeoutInMillis(123) .type("type") .uri("uri") .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnMethod.IntegrationProperty
static final class
An implementation forCfnMethod.IntegrationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
A list of request parameters whose values API Gateway caches.default String
Specifies a group of related cached parameters.default String
The ID of the VpcLink used for the integration whenconnectionType=VPC_LINK
and undefined, otherwise.default String
The type of the network connection to the integration endpoint.default String
Specifies how to handle request payload content type conversions.default String
Specifies the credentials required for the integration, if any.default String
Specifies the integration's HTTP method type.default Object
Specifies the integration's responses.default 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.default Object
A key-value map specifying request parameters that are passed from the method request to the back end.default Object
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.default Number
Custom timeout between 50 and 29,000 milliseconds.default String
getType()
Specifies an API method integration type.default String
getUri()
Specifies Uniform Resource Identifier (URI) of the integration endpoint.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCacheKeyParameters
A list of request parameters whose values API Gateway caches.To be valid values for
cacheKeyParameters
, these parameters must also be specified for MethodrequestParameters
. -
getCacheNamespace
Specifies a group of related cached parameters.By default, API Gateway uses the resource ID as the
cacheNamespace
. You can specify the samecacheNamespace
across resources to return the same cached data for requests to different resources. -
getConnectionId
The ID of the VpcLink used for the integration whenconnectionType=VPC_LINK
and undefined, otherwise. -
getConnectionType
The type of the network connection to the integration endpoint.The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
. -
getContentHandling
Specifies how to handle request payload content type conversions.Supported values are
CONVERT_TO_BINARY
andCONVERT_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. -
getCredentials
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. -
getIntegrationHttpMethod
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 toPOST
. For all other types, you must specify this property. -
getIntegrationResponses
Specifies the integration's responses. -
getPassthroughBehavior
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. -
getRequestParameters
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}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name. -
getRequestTemplates
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.
-
getTimeoutInMillis
Custom timeout between 50 and 29,000 milliseconds.The default value is 29,000 milliseconds or 29 seconds.
-
getType
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 aconnectionType
ofVPC_LINK
is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC. -
getUri
Specifies Uniform Resource Identifier (URI) of the integration endpoint.For
HTTP
orHTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. IfconnectionType
isVPC_LINK
specify the Network Load Balancer DNS name. ForAWS
orAWS_PROXY
integrations, the URI is of the formarn: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 eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
-
builder
-