IntegrationConfig
- class aws_cdk.aws_apigateway.IntegrationConfig(*, type, deployment_token=None, integration_http_method=None, options=None, uri=None)
Bases:
object
Result of binding an Integration to a Method.
- Parameters:
type (
IntegrationType
) – Specifies an API method integration type.deployment_token (
Optional
[str
]) – This value is included in computing the Deployment’s fingerprint. When the fingerprint changes, a new deployment is triggered. This property should contain values associated with the Integration that upon changing should trigger a fresh the Deployment needs to be refreshed. Default: undefined deployments are not triggered for any change to this integration.integration_http_method (
Optional
[str
]) – The integration’s HTTP method type. Required unless you use a MOCK integration. Default: - no integration method specified.options (
Union
[IntegrationOptions
,Dict
[str
,Any
],None
]) – Integration options. Default: - no integration optionsuri (
Optional
[str
]) – The Uniform Resource Identifier (URI) for the integration. Default: - no URI. Usually applies to MOCK integration
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk as cdk from aws_cdk import aws_apigateway as apigateway from aws_cdk import aws_iam as iam # role: iam.Role # vpc_link: apigateway.VpcLink integration_config = apigateway.IntegrationConfig( type=apigateway.IntegrationType.AWS, # the properties below are optional deployment_token="deploymentToken", integration_http_method="integrationHttpMethod", options=apigateway.IntegrationOptions( cache_key_parameters=["cacheKeyParameters"], cache_namespace="cacheNamespace", connection_type=apigateway.ConnectionType.INTERNET, content_handling=apigateway.ContentHandling.CONVERT_TO_BINARY, credentials_passthrough=False, credentials_role=role, integration_responses=[apigateway.IntegrationResponse( status_code="statusCode", # the properties below are optional content_handling=apigateway.ContentHandling.CONVERT_TO_BINARY, response_parameters={ "response_parameters_key": "responseParameters" }, response_templates={ "response_templates_key": "responseTemplates" }, selection_pattern="selectionPattern" )], passthrough_behavior=apigateway.PassthroughBehavior.WHEN_NO_MATCH, request_parameters={ "request_parameters_key": "requestParameters" }, request_templates={ "request_templates_key": "requestTemplates" }, timeout=cdk.Duration.minutes(30), vpc_link=vpc_link ), uri="uri" )
Attributes
- deployment_token
This value is included in computing the Deployment’s fingerprint.
When the fingerprint changes, a new deployment is triggered. This property should contain values associated with the Integration that upon changing should trigger a fresh the Deployment needs to be refreshed.
- Default:
undefined deployments are not triggered for any change to this integration.
- integration_http_method
The integration’s HTTP method type.
Required unless you use a MOCK integration.
- Default:
no integration method specified.
- options
Integration options.
- Default:
no integration options
- type
Specifies an API method integration type.
- uri
The Uniform Resource Identifier (URI) for the integration.
- Default:
no URI. Usually applies to MOCK integration
- See:
https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#uri