CfnApiProps

class aws_cdk.aws_apigatewayv2.CfnApiProps(*, api_key_selection_expression=None, base_path=None, body=None, body_s3_location=None, cors_configuration=None, credentials_arn=None, description=None, disable_execute_api_endpoint=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

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

Parameters
  • api_key_selection_expression (Optional[str]) – AWS::ApiGatewayV2::Api.ApiKeySelectionExpression.

  • base_path (Optional[str]) – AWS::ApiGatewayV2::Api.BasePath.

  • body (Optional[Any]) – AWS::ApiGatewayV2::Api.Body.

  • body_s3_location (Union[IResolvable, BodyS3LocationProperty, None]) – AWS::ApiGatewayV2::Api.BodyS3Location.

  • cors_configuration (Union[IResolvable, CorsProperty, None]) – AWS::ApiGatewayV2::Api.CorsConfiguration.

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

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

  • disable_execute_api_endpoint (Union[bool, IResolvable, None]) – AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint.

  • disable_schema_validation (Union[bool, IResolvable, None]) – AWS::ApiGatewayV2::Api.DisableSchemaValidation.

  • fail_on_warnings (Union[bool, IResolvable, None]) – AWS::ApiGatewayV2::Api.FailOnWarnings.

  • name (Optional[str]) – AWS::ApiGatewayV2::Api.Name.

  • protocol_type (Optional[str]) – AWS::ApiGatewayV2::Api.ProtocolType.

  • route_key (Optional[str]) – AWS::ApiGatewayV2::Api.RouteKey.

  • route_selection_expression (Optional[str]) – AWS::ApiGatewayV2::Api.RouteSelectionExpression.

  • tags (Optional[Any]) – AWS::ApiGatewayV2::Api.Tags.

  • target (Optional[str]) – AWS::ApiGatewayV2::Api.Target.

  • version (Optional[str]) – AWS::ApiGatewayV2::Api.Version.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.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

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

cfn_api_props = apigatewayv2.CfnApiProps(
    api_key_selection_expression="apiKeySelectionExpression",
    base_path="basePath",
    body=body,
    body_s3_location=apigatewayv2.CfnApi.BodyS3LocationProperty(
        bucket="bucket",
        etag="etag",
        key="key",
        version="version"
    ),
    cors_configuration=apigatewayv2.CfnApi.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_execute_api_endpoint=False,
    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"
)

Attributes

api_key_selection_expression

AWS::ApiGatewayV2::Api.ApiKeySelectionExpression.

Link

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

Return type

Optional[str]

base_path

AWS::ApiGatewayV2::Api.BasePath.

Link

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

Return type

Optional[str]

body

AWS::ApiGatewayV2::Api.Body.

Link

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

Return type

Any

body_s3_location

AWS::ApiGatewayV2::Api.BodyS3Location.

Link

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

Return type

Union[IResolvable, BodyS3LocationProperty, None]

cors_configuration

AWS::ApiGatewayV2::Api.CorsConfiguration.

Link

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

Return type

Union[IResolvable, CorsProperty, None]

credentials_arn

AWS::ApiGatewayV2::Api.CredentialsArn.

Link

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

Return type

Optional[str]

description

AWS::ApiGatewayV2::Api.Description.

Link

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

Return type

Optional[str]

disable_execute_api_endpoint

AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint.

Link

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

Return type

Union[bool, IResolvable, None]

disable_schema_validation

AWS::ApiGatewayV2::Api.DisableSchemaValidation.

Link

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

Return type

Union[bool, IResolvable, None]

fail_on_warnings

AWS::ApiGatewayV2::Api.FailOnWarnings.

Link

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

Return type

Union[bool, IResolvable, None]

name

AWS::ApiGatewayV2::Api.Name.

Link

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

Return type

Optional[str]

protocol_type

AWS::ApiGatewayV2::Api.ProtocolType.

Link

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

Return type

Optional[str]

route_key

AWS::ApiGatewayV2::Api.RouteKey.

Link

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

Return type

Optional[str]

route_selection_expression

AWS::ApiGatewayV2::Api.RouteSelectionExpression.

Link

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

Return type

Optional[str]

tags

AWS::ApiGatewayV2::Api.Tags.

Link

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

Return type

Any

target

AWS::ApiGatewayV2::Api.Target.

Link

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

Return type

Optional[str]

version

AWS::ApiGatewayV2::Api.Version.

Link

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

Return type

Optional[str]