CfnBasePathMappingProps¶
-
class
aws_cdk.aws_apigateway.
CfnBasePathMappingProps
(*, domain_name, base_path=None, id=None, rest_api_id=None, stage=None)¶ Bases:
object
Properties for defining a
CfnBasePathMapping
.- Parameters
domain_name (
str
) – TheDomainName
of an AWS::ApiGateway::DomainName resource.base_path (
Optional
[str
]) – The base path name that callers of the API must provide in the URL after the domain name.id (
Optional
[str
]) –AWS::ApiGateway::BasePathMapping.Id
.rest_api_id (
Optional
[str
]) – The ID of the API.stage (
Optional
[str
]) – The name of the API’s stage.
- Link
- ExampleMetadata
fixture=_generated
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 cfn_base_path_mapping_props = apigateway.CfnBasePathMappingProps( domain_name="domainName", # the properties below are optional base_path="basePath", id="id", rest_api_id="restApiId", stage="stage" )
Attributes
-
base_path
¶ The base path name that callers of the API must provide in the URL after the domain name.
-
domain_name
¶ //docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html>`_ resource.
- Link
- Type
The
DomainName
of an `AWS::ApiGateway::DomainName <https- Return type
str
-
id
¶ AWS::ApiGateway::BasePathMapping.Id
.
-
rest_api_id
¶ The ID of the API.
-
stage
¶ The name of the API’s stage.