CfnBasePathMappingProps Struct
Properties for defining a CfnBasePathMapping.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
const cfnBasePathMappingProps: apigateway.CfnBasePathMappingProps = {
domainName: 'domainName',
// the properties below are optional
basePath: 'basePath',
id: 'id',
restApiId: 'restApiId',
stage: 'stage',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import 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"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.apigateway.*;
CfnBasePathMappingProps cfnBasePathMappingProps = CfnBasePathMappingProps.builder()
.domainName("domainName")
// the properties below are optional
.basePath("basePath")
.id("id")
.restApiId("restApiId")
.stage("stage")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGateway;
var cfnBasePathMappingProps = new CfnBasePathMappingProps {
DomainName = "domainName",
// the properties below are optional
BasePath = "basePath",
Id = "id",
RestApiId = "restApiId",
Stage = "stage"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnBasePathMappingProps := &CfnBasePathMappingProps{
DomainName: jsii.String("domainName"),
// the properties below are optional
BasePath: jsii.String("basePath"),
Id: jsii.String("id"),
RestApiId: jsii.String("restApiId"),
Stage: jsii.String("stage"),
}
Properties
basePathoptionalstringbase_pathoptionalstrbasePathoptionalStringBasePathoptionalstringBasePathoptional*string#The base path name that callers of the API must provide as part of the URL after the domain name.
domainNamestring | IDomainNameRefdomain_nametyping.Union[str, IDomainNameRef]domainNameStringDomainNamestringDomainNameinterface{}required#The domain name of the BasePathMapping resource to be described.
restApiIdoptionalstring | IRestApiRefrest_api_idoptionaltyping.Union[str, IRestApiRef]restApiIdoptionalStringRestApiIdoptionalstringRestApiIdoptionalinterface{}#The string identifier of the associated RestApi.