IntegrationOptions¶

class aws_cdk.aws_apigateway.IntegrationOptions(*, cache_key_parameters=None, cache_namespace=None, connection_type=None, content_handling=None, credentials_passthrough=None, credentials_role=None, integration_responses=None, passthrough_behavior=None, request_parameters=None, request_templates=None, vpc_link=None)¶

Bases: object

__init__(*, cache_key_parameters=None, cache_namespace=None, connection_type=None, content_handling=None, credentials_passthrough=None, credentials_role=None, integration_responses=None, passthrough_behavior=None, request_parameters=None, request_templates=None, vpc_link=None)¶

param cache_key_parameters

A list of request parameters whose values are to be cached. It determines request parameters that will make it into the cache key.

param cache_namespace

An API-specific tag group of related cached parameters.

param connection_type

The type of network connection to the integration endpoint. Default: ConnectionType.Internet

param content_handling

Specifies how to handle request payload content type conversions. Default: none if this property isn’t defined, the request payload is passed through from the method request to the integration request without modification, provided that the passthroughBehaviors property is configured to support payload pass-through.

param credentials_passthrough

Requires that the caller’s identity be passed through from the request. Default: Caller identity is not passed through

param credentials_role

An IAM role that API Gateway assumes. Mutually exclusive with credentialsPassThrough. Default: A role is not assumed

param integration_responses

The response that API Gateway provides after a method’s backend completes processing a request. API Gateway intercepts the response from the backend so that you can control how API Gateway surfaces backend responses. For example, you can map the backend status codes to codes that you define.

param passthrough_behavior

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

param request_parameters

The request parameters that API Gateway sends with the backend request. Specify request parameters as key-value pairs (string-to-string mappings), with a destination as the key and a source as the value. Specify the destination by using the following pattern integration.request.location.name, where location is querystring, path, or header, and name is a valid, unique parameter name. The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on their destination in the request.

param request_templates

A map of Apache Velocity templates that are applied on the request payload. The template that API Gateway uses is based on the value of the Content-Type header that’s sent by the client. The content type value is the key, and the template is the value (specified as a string), such as the following snippet: { “application/json”: “{

“statusCode”: “200”

}” }

param vpc_link: The VpcLink used for the integration. Required if connectionType is VPC_LINK

Attributes

cache_key_parameters¶

A list of request parameters whose values are to be cached.

It determines request parameters that will make it into the cache key.

Return type: Optional[List[str]]

cache_namespace¶

An API-specific tag group of related cached parameters.

Return type: Optional[str]

connection_type¶

The type of network connection to the integration endpoint.

default :default: ConnectionType.Internet

Return type: Optional[ConnectionType]

content_handling¶

Specifies how to handle request payload content type conversions.

default :default:

none if this property isn’t defined, the request payload is passed through from the method request to the integration request without modification, provided that the passthroughBehaviors property is configured to support payload pass-through.

Return type: Optional[ContentHandling]

credentials_passthrough¶

Requires that the caller’s identity be passed through from the request.

default :default: Caller identity is not passed through

Return type: Optional[bool]

credentials_role¶

An IAM role that API Gateway assumes.

Mutually exclusive with credentialsPassThrough.

default :default: A role is not assumed

Return type: Optional[IRole]

integration_responses¶

The response that API Gateway provides after a method’s backend completes processing a request.

API Gateway intercepts the response from the backend so that you can control how API Gateway surfaces backend responses. For example, you can map the backend status codes to codes that you define.

Return type: Optional[List[IntegrationResponse]]

passthrough_behavior¶

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.

There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

Return type: Optional[PassthroughBehavior]

request_parameters¶

The request parameters that API Gateway sends with the backend request.

Specify request parameters as key-value pairs (string-to-string mappings), with a destination as the key and a source as the value.

Specify the destination by using the following pattern integration.request.location.name, where location is querystring, path, or header, and name is a valid, unique parameter name.

The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on their destination in the request.

Return type: Optional[Mapping[str, str]]

request_templates¶

A map of Apache Velocity templates that are applied on the request payload.

The template that API Gateway uses is based on the value of the Content-Type header that’s sent by the client. The content type value is the key, and the template is the value (specified as a string), such as the following snippet:

{ “application/json”: “{

“statusCode”: “200”

}” }

see :see: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html

Return type: Optional[Mapping[str, str]]

vpc_link¶

The VpcLink used for the integration.

Required if connectionType is VPC_LINK

Return type: Optional[VpcLink]