ApiMapping

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

Bases: Resource

Create a new API mapping for API Gateway API endpoint.

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.
from aws_cdk import 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) – The Api to which this mapping is applied.
domain_name (IDomainName) – custom domain name of the mapping target.
api_mapping_key (Optional[str]) – 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]) – 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

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: ID of the API Mapping.

domain_name: API domain name.

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.

mapping_key: API Mapping key.

node: The tree node.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_api_mapping_attributes(scope, id, *, api_mapping_id)

import from API ID.

Parameters:

scope (Construct) –
id (str) –
api_mapping_id (str) – The API mapping ID.

Return type:

IApiMapping

classmethod is_construct(x)

Checks if x is a construct.

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:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool