IntegrationConfig

class aws_cdk.aws_apigateway.IntegrationConfig(*, type, deployment_token=None, integration_http_method=None, options=None, uri=None)

Bases: object

__init__(*, type, deployment_token=None, integration_http_method=None, options=None, uri=None)

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. Default: - no integration method specified.

  • options (Optional[IntegrationOptions]) – Integration options. Default: - no integration options

  • uri (Optional[str]) – The Uniform Resource Identifier (URI) for the integration. Default: - no URI. Usually applies to MOCK integration

Return type

None

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 :default: undefined deployments are not triggered for any change to this integration.

Return type

Optional[str]

integration_http_method

The integration’s HTTP method type.

default :default: - no integration method specified.

Return type

Optional[str]

options

Integration options.

default :default: - no integration options

Return type

Optional[IntegrationOptions]

type

Specifies an API method integration type.

Return type

IntegrationType

uri

The Uniform Resource Identifier (URI) for the integration.

default :default: - no URI. Usually applies to MOCK integration

see :see: https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#uri

Return type

Optional[str]