ApiMapping

class aws_cdk.aws_apigatewayv2.ApiMapping(scope, id, *, api, domain_name, api_mapping_key=None, stage=None)

Bases: aws_cdk.core.Resource

(experimental) Create a new API mapping for API Gateway API endpoint.

Stability

experimental

Resource

AWS::ApiGatewayV2::ApiMapping

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_apigatewayv2 as apigatewayv2

# api: apigatewayv2.IApi
# domain_name: apigatewayv2.DomainName
# stage: apigatewayv2.IStage

api_mapping = apigatewayv2.ApiMapping(self, "MyApiMapping",
    api=api,
    domain_name=domain_name,

    # the properties below are optional
    api_mapping_key="apiMappingKey",
    stage=stage
)
Parameters

  • scope (Construct) –

  • id (str) –

  • api (IApi) – (experimental) The Api to which this mapping is applied.

  • domain_name (IDomainName) – (experimental) custom domain name of the mapping target.

  • api_mapping_key (Optional[str]) – (experimental) Api mapping key. The path where this stage should be mapped to on the domain Default: - undefined for the root path mapping.

  • stage (Optional[IStage]) – (experimental) stage for the ApiMapping resource required for WebSocket API defaults to default stage of an HTTP API. Default: - Default stage of the passed API for HTTP API, required for WebSocket API

Stability

experimental

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

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).

Parameters

policy (RemovalPolicy) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

api_mapping_id

(experimental) ID of the API Mapping.

Stability

experimental

Return type

str

domain_name

(experimental) API domain name.

Stability

experimental

Return type

IDomainName

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

mapping_key

(experimental) API Mapping key.

Stability

experimental

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_api_mapping_attributes(scope, id, *, api_mapping_id)

(experimental) import from API ID.

Parameters

  • scope (Construct) –

  • id (str) –

  • api_mapping_id (str) – (experimental) The API mapping ID.

Stability

experimental

Return type

IApiMapping

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool