ApiMapping L2 construct
Create a new API mapping for API Gateway API endpoint.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
import { aws_apigatewayv2 as interfaces_apigatewayv2 } from 'aws-cdk-lib/interfaces';
declare const apiRef: interfaces_apigatewayv2.IApiRef;
declare const domainNameRef: interfaces_apigatewayv2.IDomainNameRef;
declare const stage: apigatewayv2.IStage;
const apiMapping = new apigatewayv2.ApiMapping(this, 'MyApiMapping', {
api: apiRef,
domainName: domainNameRef,
// the properties below are optional
apiMappingKey: 'apiMappingKey',
stage: stage,
});
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2
from aws_cdk.interfaces import aws_apigatewayv2 as interfaces_apigatewayv2
# api_ref: interfaces_apigatewayv2.IApiRef
# domain_name_ref: interfaces_apigatewayv2.IDomainNameRef
# stage: apigatewayv2.IStage
api_mapping = apigatewayv2.ApiMapping(self, "MyApiMapping",
api=api_ref,
domain_name=domain_name_ref,
# the properties below are optional
api_mapping_key="apiMappingKey",
stage=stage
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.apigatewayv2.*;
import software.amazon.awscdk.interfaces.apigatewayv2.*;
IApiRef apiRef;
IDomainNameRef domainNameRef;
IStage stage;
ApiMapping apiMapping = ApiMapping.Builder.create(this, "MyApiMapping")
.api(apiRef)
.domainName(domainNameRef)
// the properties below are optional
.apiMappingKey("apiMappingKey")
.stage(stage)
.build();
// 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.Apigatewayv2;
using Amazon.CDK.Interfaces.Apigatewayv2;
IApiRef apiRef;
IDomainNameRef domainNameRef;
IStage stage;
var apiMapping = new ApiMapping(this, "MyApiMapping", new ApiMappingProps {
Api = apiRef,
DomainName = domainNameRef,
// the properties below are optional
ApiMappingKey = "apiMappingKey",
Stage = stage
});
// 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"
import "github.com/aws/aws-cdk-go/awscdk"
var apiRef IApiRef
var domainNameRef IDomainNameRef
var stage IStage
apiMapping := awscdk.Aws_apigatewayv2.NewApiMapping(this, jsii.String("MyApiMapping"), &ApiMappingProps{
Api: apiRef,
DomainName: domainNameRef,
// the properties below are optional
ApiMappingKey: jsii.String("apiMappingKey"),
Stage: stage,
})
Initializer
new ApiMapping(scope: Construct, id: string, props: ApiMappingProps)
ApiMapping(scope: Construct, id: str, props: ApiMappingProps)
new ApiMapping(Construct scope, String id, ApiMappingProps props)
new ApiMapping(Construct scope, string id, ApiMappingProps props)
NewApiMapping(Scope Construct, Id *string, Props ApiMappingProps)
Construct Props
apiMappingKeystringapi_mapping_keystrapiMappingKeyStringApiMappingKeystringApiMappingKey*string= undefined for the root path mapp…#The path where this stage should be mapped to on the domain
default
Default: undefined for the root path mapping.
domainNameIDomainNameRefdomain_nameIDomainNameRefdomainNameIDomainNameRefDomainNameIDomainNameRefDomainNameIDomainNameRefrequired#Properties
apiMappingRefApiMappingReferenceapi_mapping_refApiMappingReferenceapiMappingRefApiMappingReferenceApiMappingRefApiMappingReferenceApiMappingRefApiMappingReferencerequired#domainNameIDomainNamedomain_nameIDomainNamedomainNameIDomainNameDomainNameIDomainNameDomainNameIDomainNamerequired#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).
fromApiMappingAttributes(scope: Construct, id: string, attrs: ApiMappingAttributes): IApiMapping@staticmethod def from_api_mapping_attributes(scope: Construct, id: str, attrs: ApiMappingAttributes) -> IApiMappingpublic static IApiMapping fromApiMappingAttributes(Construct scope, String id, ApiMappingAttributes attrs)public static IApiMapping FromApiMappingAttributes(Construct scope, string id, ApiMappingAttributes attrs)func FromApiMappingAttributes(Scope Construct, Id *string, Attrs ApiMappingAttributes) IApiMappingstatic#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.