CfnIntegrationProps

class aws_cdk.aws_apigatewayv2.CfnIntegrationProps(*, api_id, connection_id=None, connection_type=None, content_handling_strategy=None, credentials_arn=None, description=None, integration_method=None, integration_subtype=None, integration_type, integration_uri=None, passthrough_behavior=None, payload_format_version=None, request_parameters=None, request_templates=None, response_parameters=None, template_selection_expression=None, timeout_in_millis=None, tls_config=None)

Bases: object

Properties for defining a AWS::ApiGatewayV2::Integration.

Parameters
  • api_id (str) – AWS::ApiGatewayV2::Integration.ApiId.

  • connection_id (Optional[str]) – AWS::ApiGatewayV2::Integration.ConnectionId.

  • connection_type (Optional[str]) – AWS::ApiGatewayV2::Integration.ConnectionType.

  • content_handling_strategy (Optional[str]) – AWS::ApiGatewayV2::Integration.ContentHandlingStrategy.

  • credentials_arn (Optional[str]) – AWS::ApiGatewayV2::Integration.CredentialsArn.

  • description (Optional[str]) – AWS::ApiGatewayV2::Integration.Description.

  • integration_method (Optional[str]) – AWS::ApiGatewayV2::Integration.IntegrationMethod.

  • integration_subtype (Optional[str]) – AWS::ApiGatewayV2::Integration.IntegrationSubtype.

  • integration_type (str) – AWS::ApiGatewayV2::Integration.IntegrationType.

  • integration_uri (Optional[str]) – AWS::ApiGatewayV2::Integration.IntegrationUri.

  • passthrough_behavior (Optional[str]) – AWS::ApiGatewayV2::Integration.PassthroughBehavior.

  • payload_format_version (Optional[str]) – AWS::ApiGatewayV2::Integration.PayloadFormatVersion.

  • request_parameters (Optional[Any]) – AWS::ApiGatewayV2::Integration.RequestParameters.

  • request_templates (Optional[Any]) – AWS::ApiGatewayV2::Integration.RequestTemplates.

  • response_parameters (Optional[Any]) – AWS::ApiGatewayV2::Integration.ResponseParameters.

  • template_selection_expression (Optional[str]) – AWS::ApiGatewayV2::Integration.TemplateSelectionExpression.

  • timeout_in_millis (Union[int, float, None]) – AWS::ApiGatewayV2::Integration.TimeoutInMillis.

  • tls_config (Union[IResolvable, TlsConfigProperty, None]) – AWS::ApiGatewayV2::Integration.TlsConfig.

Link

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

Example:

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

# request_parameters is of type object
# request_templates is of type object
# response_parameters is of type object

cfn_integration_props = apigatewayv2.CfnIntegrationProps(
    api_id="apiId",
    integration_type="integrationType",

    # the properties below are optional
    connection_id="connectionId",
    connection_type="connectionType",
    content_handling_strategy="contentHandlingStrategy",
    credentials_arn="credentialsArn",
    description="description",
    integration_method="integrationMethod",
    integration_subtype="integrationSubtype",
    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.CfnIntegration.TlsConfigProperty(
        server_name_to_verify="serverNameToVerify"
    )
)

Attributes

api_id

AWS::ApiGatewayV2::Integration.ApiId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-apiid

Return type

str

connection_id

AWS::ApiGatewayV2::Integration.ConnectionId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-connectionid

Return type

Optional[str]

connection_type

AWS::ApiGatewayV2::Integration.ConnectionType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-connectiontype

Return type

Optional[str]

content_handling_strategy

AWS::ApiGatewayV2::Integration.ContentHandlingStrategy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-contenthandlingstrategy

Return type

Optional[str]

credentials_arn

AWS::ApiGatewayV2::Integration.CredentialsArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-credentialsarn

Return type

Optional[str]

description

AWS::ApiGatewayV2::Integration.Description.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-description

Return type

Optional[str]

integration_method

AWS::ApiGatewayV2::Integration.IntegrationMethod.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationmethod

Return type

Optional[str]

integration_subtype

AWS::ApiGatewayV2::Integration.IntegrationSubtype.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationsubtype

Return type

Optional[str]

integration_type

AWS::ApiGatewayV2::Integration.IntegrationType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationtype

Return type

str

integration_uri

AWS::ApiGatewayV2::Integration.IntegrationUri.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationuri

Return type

Optional[str]

passthrough_behavior

AWS::ApiGatewayV2::Integration.PassthroughBehavior.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-passthroughbehavior

Return type

Optional[str]

payload_format_version

AWS::ApiGatewayV2::Integration.PayloadFormatVersion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-payloadformatversion

Return type

Optional[str]

request_parameters

AWS::ApiGatewayV2::Integration.RequestParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requestparameters

Return type

Any

request_templates

AWS::ApiGatewayV2::Integration.RequestTemplates.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requesttemplates

Return type

Any

response_parameters

AWS::ApiGatewayV2::Integration.ResponseParameters.

Link

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

Return type

Any

template_selection_expression

AWS::ApiGatewayV2::Integration.TemplateSelectionExpression.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-templateselectionexpression

Return type

Optional[str]

timeout_in_millis

AWS::ApiGatewayV2::Integration.TimeoutInMillis.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-timeoutinmillis

Return type

Union[int, float, None]

tls_config

AWS::ApiGatewayV2::Integration.TlsConfig.

Link

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

Return type

Union[IResolvable, TlsConfigProperty, None]