# DomainName

Extends: Construct › Resource › DomainName
Implements: IResource, IDomainName, IEnvironmentAware, IDomainNameRef, IConstruct, IDependable

- CloudFormation: [`AWS::ApiGateway::DomainName`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-apigateway-domainname.html)
- L1 type: [`CfnDomainName`](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.CfnDomainName.html)
- Source: [`aws-apigateway/lib/domain-name.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-apigateway/lib/domain-name.ts#L203)
- Type last changed: v2.224.0 · 13 Nov 2025

## Example

```ts
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,
});
```

## Initializer

```ts
new DomainName(scope: Construct, id: string, props: DomainNameProps)
```

## Construct Props

- `basePath`: string — 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`).

- `certificate`: [ICertificateRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_certificatemanager.ICertificateRef.html) (required) — 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.

- `domainName`: string (required) — The custom domain name for your API.

  Uppercase letters are not supported.

- `endpointAccessMode`: [EndpointAccessMode](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.EndpointAccessMode.html) — The endpoint access mode for this domain name.

  **Default:** No endpoint access mode is configured. Required for enhanced security policies.

  When using enhanced security policies (those starting with `SecurityPolicy_`),
  you must specify this property. STRICT is recommended for production workloads,
  but BASIC may be needed during migration or for certain application architectures.

- `endpointType`: [EndpointType](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.EndpointType.html) = REGIONAL — The type of endpoint for this DomainName.

- `mapping`: [IRestApi](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.IRestApi.html) — If specified, all requests to this domain will be mapped to the production deployment of this API.

  **Default:** you will have to call `addBasePathMapping` to map this domain to API endpoints.

  If you wish to map this domain to multiple APIs
  with different base paths, use `addBasePathMapping` or `addApiMapping`.

- `mtls`: [MTLSConfig](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.MTLSConfig.html) — The mutual TLS authentication configuration for a custom domain name.

  **Default:** mTLS is not configured.

- `securityPolicy`: [SecurityPolicy](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.SecurityPolicy.html) = SecurityPolicy.TLS_1_2 — The Transport Layer Security (TLS) version + cipher suite for this domain name.

## Properties

- `domainName`: string — The domain name (e.g. `example.com`).

- `domainNameAliasDomainName`: string — The Route53 alias target to use in order to connect a record set to this domain through an alias.

- `domainNameAliasHostedZoneId`: string — The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.

- `domainNameRef`: [DomainNameReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_apigateway.DomainNameReference.html) — A reference to a DomainName resource.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  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.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

## Methods

- `addApiMapping(targetStage: IStageRef, options?: ApiMappingOptions): void` — 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 or higher for multi-level base paths (TLS 1.0 is not supported for multi-level paths)
  - EndpointType.REGIONAL

  **Parameters**

  - `targetStage` — the target API stage.
  - `options` — Options for mapping to a stage.

- `addBasePathMapping(targetApi: IRestApiRef, options?: BasePathMappingOptions): BasePathMapping` — 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**

  - `targetApi` — That target API endpoint, requests will be mapped to the deployment stage.
  - `options` — Options for mapping to base path with or without a stage.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  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**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — 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`).

- `fromDomainNameAttributes(scope: Construct, id: string, attrs: DomainNameAttributes): IDomainName` (static) — Imports an existing domain name.

- `isConstruct(x: any): boolean` (static) — 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 object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  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.