CfnIntegrationResponsePropsMixin

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

Bases: Mixin

The AWS::ApiGatewayV2::IntegrationResponse resource updates an integration response for an WebSocket API.

For more information, see Set up WebSocket API Integration Responses in API Gateway in the API Gateway Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html
CloudformationResource:: AWS::ApiGatewayV2::IntegrationResponse
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

# response_parameters: Any
# response_templates: Any

cfn_integration_response_props_mixin = apigatewayv2_mixins.CfnIntegrationResponsePropsMixin(apigatewayv2_mixins.CfnIntegrationResponseMixinProps(
    api_id="apiId",
    content_handling_strategy="contentHandlingStrategy",
    integration_id="integrationId",
    integration_response_key="integrationResponseKey",
    response_parameters=response_parameters,
    response_templates=response_templates,
    template_selection_expression="templateSelectionExpression"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnIntegrationResponseMixinProps, 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', 'contentHandlingStrategy', 'integrationId', 'integrationResponseKey', 'responseParameters', 'responseTemplates', 'templateSelectionExpression']

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