CfnApiV2Props

class aws_cdk.aws_apigateway.CfnApiV2Props(*, name, protocol_type, route_selection_expression, api_key_selection_expression=None, description=None, disable_schema_validation=None, tags=None, version=None)

Bases: object

__init__(*, name, protocol_type, route_selection_expression, api_key_selection_expression=None, description=None, disable_schema_validation=None, tags=None, version=None)

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

Parameters
  • name (str) – AWS::ApiGatewayV2::Api.Name.

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

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

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

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

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

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

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

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

Attributes

api_key_selection_expression

AWS::ApiGatewayV2::Api.ApiKeySelectionExpression.

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

Return type

Optional[str]

description

AWS::ApiGatewayV2::Api.Description.

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

Return type

Optional[str]

disable_schema_validation

AWS::ApiGatewayV2::Api.DisableSchemaValidation.

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

Return type

Union[bool, None, IResolvable]

name

AWS::ApiGatewayV2::Api.Name.

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

Return type

str

protocol_type

AWS::ApiGatewayV2::Api.ProtocolType.

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

Return type

str

route_selection_expression

AWS::ApiGatewayV2::Api.RouteSelectionExpression.

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

Return type

str

tags

AWS::ApiGatewayV2::Api.Tags.

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

Return type

Any

version

AWS::ApiGatewayV2::Api.Version.

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

Return type

Optional[str]