class CfnDomainName (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.APIGateway.CfnDomainName`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnDomainName`
Java	`software.amazon.awscdk.services.apigateway.CfnDomainName`
Python	`aws_cdk.aws_apigateway.CfnDomainName`
TypeScript	`aws-cdk-lib` » `aws_apigateway` » `CfnDomainName`

Implements IConstruct, IDependable, IInspectable, ITaggable

The AWS::ApiGateway::DomainName resource specifies a custom domain name for your API in API Gateway.

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
const cfnDomainName = new apigateway.CfnDomainName(this, 'MyCfnDomainName', /* all optional props */ {
  certificateArn: 'certificateArn',
  domainName: 'domainName',
  endpointConfiguration: {
    types: ['types'],
  },
  mutualTlsAuthentication: {
    truststoreUri: 'truststoreUri',
    truststoreVersion: 'truststoreVersion',
  },
  ownershipVerificationCertificateArn: 'ownershipVerificationCertificateArn',
  regionalCertificateArn: 'regionalCertificateArn',
  securityPolicy: 'securityPolicy',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnDomainName(scope: Construct, id: string, props?: CfnDomainNameProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnDomainNameProps — Resource properties.

Construct Props

Name	Type	Description
certificateArn?	`string`	The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.
domainName?	`string`	The custom domain name as an API host name, for example, `my-api.example.com` .
endpointConfiguration?	`IResolvable` `\|` `EndpointConfigurationProperty`	The endpoint configuration of this DomainName showing the endpoint types of the domain name.
mutualTlsAuthentication?	`IResolvable` `\|` `MutualTlsAuthenticationProperty`	The mutual TLS authentication configuration for a custom domain name.
ownershipVerificationCertificateArn?	`string`	The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
regionalCertificateArn?	`string`	The reference to an AWS -managed certificate that will be used for validating the regional domain name.
securityPolicy?	`string`	The Transport Layer Security (TLS) version + cipher suite for this DomainName.
tags?	`CfnTag[]`	The collection of tags.

certificateArn?

Type: string (optional)

The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.

AWS Certificate Manager is the only supported source.

domainName?

Type: string (optional)

The custom domain name as an API host name, for example, my-api.example.com .

endpointConfiguration?

Type: IResolvable | EndpointConfigurationProperty (optional)

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

mutualTlsAuthentication?

Type: IResolvable | MutualTlsAuthenticationProperty (optional)

The mutual TLS authentication configuration for a custom domain name.

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

ownershipVerificationCertificateArn?

Type: string (optional)

The ARN of the public certificate issued by ACM to validate ownership of your custom domain.

Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.

regionalCertificateArn?

Type: string (optional)

The reference to an AWS -managed certificate that will be used for validating the regional domain name.

AWS Certificate Manager is the only supported source.

securityPolicy?

Type: string (optional)

The Transport Layer Security (TLS) version + cipher suite for this DomainName.

The valid values are TLS_1_0 and TLS_1_2 .

tags?

Type: CfnTag[] (optional)

The collection of tags.

Each tag element is associated with a given resource.

Properties

Name	Type	Description
attrDistributionDomainName	`string`	The Amazon CloudFront distribution domain name that's mapped to the custom domain name.
attrDistributionHostedZoneId	`string`	The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.
attrRegionalDomainName	`string`	The domain name associated with the regional endpoint for this custom domain name.
attrRegionalHostedZoneId	`string`	The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
certificateArn?	`string`	The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.
domainName?	`string`	The custom domain name as an API host name, for example, `my-api.example.com` .
endpointConfiguration?	`IResolvable` `\|` `EndpointConfigurationProperty`	The endpoint configuration of this DomainName showing the endpoint types of the domain name.
mutualTlsAuthentication?	`IResolvable` `\|` `MutualTlsAuthenticationProperty`	The mutual TLS authentication configuration for a custom domain name.
ownershipVerificationCertificateArn?	`string`	The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
regionalCertificateArn?	`string`	The reference to an AWS -managed certificate that will be used for validating the regional domain name.
securityPolicy?	`string`	The Transport Layer Security (TLS) version + cipher suite for this DomainName.
tagsRaw?	`CfnTag[]`	The collection of tags.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrDistributionDomainName

Type: string

The Amazon CloudFront distribution domain name that's mapped to the custom domain name.

This is only applicable for endpoints whose type is EDGE .

Example: d111111abcdef8.cloudfront.net

attrDistributionHostedZoneId

Type: string

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.

The only valid value is Z2FDTNDATAQYW2 for all regions.

attrRegionalDomainName

Type: string

The domain name associated with the regional endpoint for this custom domain name.

You set up this association by adding a DNS record that points the custom domain name to this regional domain name.

attrRegionalHostedZoneId

Type: string

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

certificateArn?

Type: string (optional)

The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.

domainName?

Type: string (optional)

The custom domain name as an API host name, for example, my-api.example.com .

endpointConfiguration?

Type: IResolvable | EndpointConfigurationProperty (optional)

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

mutualTlsAuthentication?

Type: IResolvable | MutualTlsAuthenticationProperty (optional)

The mutual TLS authentication configuration for a custom domain name.

ownershipVerificationCertificateArn?

Type: string (optional)

The ARN of the public certificate issued by ACM to validate ownership of your custom domain.

regionalCertificateArn?

Type: string (optional)

The reference to an AWS -managed certificate that will be used for validating the regional domain name.

securityPolicy?

Type: string (optional)

The Transport Layer Security (TLS) version + cipher suite for this DomainName.

tagsRaw?

Type: CfnTag[] (optional)

The collection of tags.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }