CfnIntegrationPropsMixin

class aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnIntegrationPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::ApiGatewayV2::Integration resource creates an integration for an API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html
CloudformationResource:: AWS::ApiGatewayV2::Integration
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_apigatewayv2 import mixins as apigatewayv2_mixins

# request_parameters: Any
# request_templates: Any
# response_parameters: Any

cfn_integration_props_mixin = apigatewayv2_mixins.CfnIntegrationPropsMixin(apigatewayv2_mixins.CfnIntegrationMixinProps(
    api_id="apiId",
    connection_id="connectionId",
    connection_type="connectionType",
    content_handling_strategy="contentHandlingStrategy",
    credentials_arn="credentialsArn",
    description="description",
    integration_method="integrationMethod",
    integration_subtype="integrationSubtype",
    integration_type="integrationType",
    integration_uri="integrationUri",
    passthrough_behavior="passthroughBehavior",
    payload_format_version="payloadFormatVersion",
    request_parameters=request_parameters,
    request_templates=request_templates,
    response_parameters=response_parameters,
    template_selection_expression="templateSelectionExpression",
    timeout_in_millis=123,
    tls_config=apigatewayv2_mixins.CfnIntegrationPropsMixin.TlsConfigProperty(
        server_name_to_verify="serverNameToVerify"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ApiGatewayV2::Integration.

Parameters:

props (Union[CfnIntegrationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['apiId', 'connectionId', 'connectionType', 'contentHandlingStrategy', 'credentialsArn', 'description', 'integrationMethod', 'integrationSubtype', 'integrationType', 'integrationUri', 'passthroughBehavior', 'payloadFormatVersion', 'requestParameters', 'requestTemplates', 'responseParameters', 'templateSelectionExpression', 'timeoutInMillis', 'tlsConfig']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ResponseParameterMapProperty

class CfnIntegrationPropsMixin.ResponseParameterMapProperty(*, response_parameters=None)

Bases: object

map of response parameter lists.

Parameters:: response_parameters (Union[IResolvable, Sequence[Union[IResolvable, ResponseParameterProperty, Dict[str, Any]]], None]) – list of response parameters.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-responseparametermap.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_apigatewayv2 import mixins as apigatewayv2_mixins

response_parameter_map_property = apigatewayv2_mixins.CfnIntegrationPropsMixin.ResponseParameterMapProperty(
    response_parameters=[apigatewayv2_mixins.CfnIntegrationPropsMixin.ResponseParameterProperty(
        destination="destination",
        source="source"
    )]
)

Attributes

response_parameters

list of response parameters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-responseparametermap.html#cfn-apigatewayv2-integration-responseparametermap-responseparameters

ResponseParameterProperty

class CfnIntegrationPropsMixin.ResponseParameterProperty(*, destination=None, source=None)

Bases: object

Supported only for HTTP APIs.

You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match the pattern <action>:<header>.<location> or overwrite.statuscode . The action can be append , overwrite or remove . The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses .

Parameters:

destination (Optional[str]) –
Specifies the location of the response to modify, and how to modify it. To learn more, see Transforming API requests and responses .
source (Optional[str]) –
Specifies the data to update the parameter with. To learn more, see Transforming API requests and responses .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-responseparameter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_apigatewayv2 import mixins as apigatewayv2_mixins

response_parameter_property = apigatewayv2_mixins.CfnIntegrationPropsMixin.ResponseParameterProperty(
    destination="destination",
    source="source"
)

Attributes

destination

Specifies the location of the response to modify, and how to modify it.

To learn more, see Transforming API requests and responses .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-responseparameter.html#cfn-apigatewayv2-integration-responseparameter-destination

source

Specifies the data to update the parameter with.

To learn more, see Transforming API requests and responses .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-responseparameter.html#cfn-apigatewayv2-integration-responseparameter-source

TlsConfigProperty

class CfnIntegrationPropsMixin.TlsConfigProperty(*, server_name_to_verify=None)

Bases: object

The TlsConfig property specifies the TLS configuration for a private integration.

If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

Parameters:: server_name_to_verify (Optional[str]) – If you specify a server name, API Gateway uses it to verify the hostname on the integration’s certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_apigatewayv2 import mixins as apigatewayv2_mixins

tls_config_property = apigatewayv2_mixins.CfnIntegrationPropsMixin.TlsConfigProperty(
    server_name_to_verify="serverNameToVerify"
)

Attributes

server_name_to_verify

If you specify a server name, API Gateway uses it to verify the hostname on the integration’s certificate.

The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html#cfn-apigatewayv2-integration-tlsconfig-servernametoverify