BasePathMapping L2 construct
This resource creates a base path that clients who call your API must use in the invocation URL.
Unless you're importing a domain with DomainName.fromDomainNameAttributes(), you can use DomainName.addBasePathMapping() to define mappings.
Example
declare const api: apigateway.RestApi;
const domainName = apigateway.DomainName.fromDomainNameAttributes(this, 'DomainName', {
domainName: 'domainName',
domainNameAliasHostedZoneId: 'domainNameAliasHostedZoneId',
domainNameAliasTarget: 'domainNameAliasTarget',
});
new apigateway.BasePathMapping(this, 'BasePathMapping', {
domainName: domainName,
restApi: api,
});
# api: apigateway.RestApi
domain_name = apigateway.DomainName.from_domain_name_attributes(self, "DomainName",
domain_name="domainName",
domain_name_alias_hosted_zone_id="domainNameAliasHostedZoneId",
domain_name_alias_target="domainNameAliasTarget"
)
apigateway.BasePathMapping(self, "BasePathMapping",
domain_name=domain_name,
rest_api=api
)
RestApi api;
IDomainName domainName = DomainName.fromDomainNameAttributes(this, "DomainName", DomainNameAttributes.builder()
.domainName("domainName")
.domainNameAliasHostedZoneId("domainNameAliasHostedZoneId")
.domainNameAliasTarget("domainNameAliasTarget")
.build());
BasePathMapping.Builder.create(this, "BasePathMapping")
.domainName(domainName)
.restApi(api)
.build();
// Install: dotnet add package Amazon.CDK.Lib
RestApi api;
var domainName = DomainName.FromDomainNameAttributes(this, "DomainName", new DomainNameAttributes {
DomainName = "domainName",
DomainNameAliasHostedZoneId = "domainNameAliasHostedZoneId",
DomainNameAliasTarget = "domainNameAliasTarget"
});
new BasePathMapping(this, "BasePathMapping", new BasePathMappingProps {
DomainName = domainName,
RestApi = api
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var api RestApi
domainName := apigateway.DomainName_FromDomainNameAttributes(this, jsii.String("DomainName"), &DomainNameAttributes{
DomainName: jsii.String("domainName"),
DomainNameAliasHostedZoneId: jsii.String("domainNameAliasHostedZoneId"),
DomainNameAliasTarget: jsii.String("domainNameAliasTarget"),
})
apigateway.NewBasePathMapping(this, jsii.String("BasePathMapping"), &BasePathMappingProps{
DomainName: domainName,
RestApi: api,
})
Initializer
new BasePathMapping(scope: Construct, id: string, props: BasePathMappingProps)
BasePathMapping(scope: Construct, id: str, props: BasePathMappingProps)
new BasePathMapping(Construct scope, String id, BasePathMappingProps props)
new BasePathMapping(Construct scope, string id, BasePathMappingProps props)
NewBasePathMapping(Scope Construct, Id *string, Props BasePathMappingProps)
Construct Props
attachToStagebooleanattach_to_stageboolattachToStageBooleanAttachToStageboolAttachToStage*bool= true#Use this property to create a base path mapping without attaching it to the Rest API default stage. This property is ignored if stage is provided.
Default: map requests from the domain root (e.g. example.com). If this is undefined, no additional mappings will be allowed on this domain name.
domainNameIDomainNameRefdomain_nameIDomainNameRefdomainNameIDomainNameRefDomainNameIDomainNameRefDomainNameIDomainNameRefrequired#restApiIRestApiRefrest_apiIRestApiRefrestApiIRestApiRefRestApiIRestApiRefRestApiIRestApiRefrequired#Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.