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',
};
Properties
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.
restApiIdstring | IRestApiRefrest_api_idtyping.Union[str, IRestApiRef]restApiIdStringRestApiIdstringRestApiIdinterface{}#The string identifier of the associated RestApi.