CfnApiV2Props¶

class aws_cdk.aws_apigateway.CfnApiV2Props(*, api_key_selection_expression=None, base_path=None, body=None, body_s3_location=None, cors_configuration=None, credentials_arn=None, description=None, disable_schema_validation=None, fail_on_warnings=None, name=None, protocol_type=None, route_key=None, route_selection_expression=None, tags=None, target=None, version=None)¶

Bases: object

(deprecated) Properties for defining a AWS::ApiGatewayV2::Api.

Parameters

api_key_selection_expression (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Api.ApiKeySelectionExpression.
base_path (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Api.BasePath.
body (Optional[Any]) – (deprecated) AWS::ApiGatewayV2::Api.Body.
body_s3_location (Union[IResolvable, BodyS3LocationProperty, None]) – (deprecated) AWS::ApiGatewayV2::Api.BodyS3Location.
cors_configuration (Union[IResolvable, CorsProperty, None]) – (deprecated) AWS::ApiGatewayV2::Api.CorsConfiguration.
credentials_arn (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Api.CredentialsArn.
description (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Api.Description.
disable_schema_validation (Union[bool, IResolvable, None]) – (deprecated) AWS::ApiGatewayV2::Api.DisableSchemaValidation.
fail_on_warnings (Union[bool, IResolvable, None]) – (deprecated) AWS::ApiGatewayV2::Api.FailOnWarnings.
name (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Api.Name.
protocol_type (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Api.ProtocolType.
route_key (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Api.RouteKey.
route_selection_expression (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Api.RouteSelectionExpression.
tags (Optional[Any]) – (deprecated) AWS::ApiGatewayV2::Api.Tags.
target (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Api.Target.
version (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Api.Version.

Deprecated

moved to package aws-apigatewayv2

See

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

Stability

deprecated

Example:

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

# body is of type object
# tags is of type object

cfn_api_v2_props = apigateway.CfnApiV2Props(
    api_key_selection_expression="apiKeySelectionExpression",
    base_path="basePath",
    body=body,
    body_s3_location=apigateway.CfnApiV2.BodyS3LocationProperty(
        bucket="bucket",
        etag="etag",
        key="key",
        version="version"
    ),
    cors_configuration=apigateway.CfnApiV2.CorsProperty(
        allow_credentials=False,
        allow_headers=["allowHeaders"],
        allow_methods=["allowMethods"],
        allow_origins=["allowOrigins"],
        expose_headers=["exposeHeaders"],
        max_age=123
    ),
    credentials_arn="credentialsArn",
    description="description",
    disable_schema_validation=False,
    fail_on_warnings=False,
    name="name",
    protocol_type="protocolType",
    route_key="routeKey",
    route_selection_expression="routeSelectionExpression",
    tags=tags,
    target="target",
    version="version"
)