DomainName

class aws_cdk.aws_apigateway.DomainName(scope, id, *, mapping=None, certificate, domain_name, base_path=None, endpoint_type=None, mtls=None, security_policy=None)

Bases: Resource

ExampleMetadata:

infused

Example:

# 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
)
Parameters:

  • scope (Construct) –

  • id (str) –

  • mapping (Optional[IRestApi]) – If specified, all requests to this domain will be mapped to the production deployment of this API. If you wish to map this domain to multiple APIs with different base paths, use addBasePathMapping or addApiMapping. Default: - you will have to call addBasePathMapping to map this domain to API endpoints.

  • certificate (ICertificate) – The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name. For “EDGE” domain names, the certificate needs to be in the US East (N. Virginia) region.

  • domain_name (str) – The custom domain name for your API. Uppercase letters are not supported.

  • base_path (Optional[str]) – The base path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path). If you specify this property, it can’t be an empty string. Default: - map requests from the domain root (e.g. example.com).

  • endpoint_type (Optional[EndpointType]) – The type of endpoint for this DomainName. Default: REGIONAL

  • mtls (Union[MTLSConfig, Dict[str, Any], None]) – The mutual TLS authentication configuration for a custom domain name. Default: - mTLS is not configured.

  • security_policy (Optional[SecurityPolicy]) – The Transport Layer Security (TLS) version + cipher suite for this domain name. Default: SecurityPolicy.TLS_1_2

Methods

add_api_mapping(target_stage, *, base_path=None)

Maps this domain to an API endpoint.

This uses the ApiMapping from ApiGatewayV2 which supports multi-level paths, but also only supports:

  • SecurityPolicy.TLS_1_2

  • EndpointType.REGIONAL

Parameters:

  • target_stage (IStage) – the target API stage.

  • base_path (Optional[str]) – The api path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path). If you specify this property, it can’t be an empty string. If this is undefined, a mapping will be added for the empty path. Any request that does not match a mapping will get sent to the API that has been mapped to the empty path. Default: - map requests from the domain root (e.g. example.com).

Return type:

None

add_base_path_mapping(target_api, *, attach_to_stage=None, base_path=None, stage=None)

Maps this domain to an API endpoint.

This uses the BasePathMapping from ApiGateway v1 which does not support multi-level paths.

If you need to create a mapping for a multi-level path use addApiMapping instead.

Parameters:

  • target_api (IRestApi) – That target API endpoint, requests will be mapped to the deployment stage.

  • attach_to_stage (Optional[bool]) – Whether to attach the base path mapping to a stage. 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: - true

  • base_path (Optional[str]) – The base path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path). If you specify this property, it can’t be an empty string. 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.

  • stage (Optional[Stage]) – The Deployment stage of API [disable-awslint:ref-via-interface]. Default: - map to deploymentStage of restApi otherwise stage needs to pass in URL

Return type:

BasePathMapping

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

domain_name

The domain name (e.g. example.com).

domain_name_alias_domain_name

The Route53 alias target to use in order to connect a record set to this domain through an alias.

domain_name_alias_hosted_zone_id

The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.

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.

node

The tree node.

stack

The stack in which this resource is defined.

Static Methods

classmethod from_domain_name_attributes(scope, id, *, domain_name, domain_name_alias_hosted_zone_id, domain_name_alias_target)

Imports an existing domain name.

Parameters:

  • scope (Construct) –

  • id (str) –

  • domain_name (str) – The domain name (e.g. example.com).

  • domain_name_alias_hosted_zone_id (str) – The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.

  • domain_name_alias_target (str) – The Route53 alias target to use in order to connect a record set to this domain through an alias.

Return type:

IDomainName

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