CfnBasePathMappingProps

class aws_cdk.aws_apigateway.CfnBasePathMappingProps(*, domain_name, base_path=None, rest_api_id=None, stage=None)

Bases: object

Properties for defining a AWS::ApiGateway::BasePathMapping.

Parameters

  • domain_name (str) – AWS::ApiGateway::BasePathMapping.DomainName.

  • base_path (Optional[str]) – AWS::ApiGateway::BasePathMapping.BasePath.

  • rest_api_id (Optional[str]) – AWS::ApiGateway::BasePathMapping.RestApiId.

  • stage (Optional[str]) – AWS::ApiGateway::BasePathMapping.Stage.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html

Attributes

base_path

AWS::ApiGateway::BasePathMapping.BasePath.

See

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

Return type

Optional[str]

domain_name

AWS::ApiGateway::BasePathMapping.DomainName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-domainname

Return type

str

rest_api_id

AWS::ApiGateway::BasePathMapping.RestApiId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-restapiid

Return type

Optional[str]

stage

AWS::ApiGateway::BasePathMapping.Stage.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-stage

Return type

Optional[str]