interface DomainNameProps

Language	Type name
.NET	`Amazon.CDK.AWS.APIGateway.DomainNameProps`
Java	`software.amazon.awscdk.services.apigateway.DomainNameProps`
Python	`aws_cdk.aws_apigateway.DomainNameProps`
TypeScript (source)	`@aws-cdk/aws-apigateway` » `DomainNameProps`

Example

declare const acm: any;

new apigateway.DomainName(this, 'domain-name', {
  domainName: 'example.com',
  certificate: acm.Certificate.fromCertificateArn(this, 'cert', 'arn:aws:acm:us-east-1:1111111:certificate/11-3336f1-44483d-adc7-9cd375c5169d'),
  mtls: {
    bucket: new s3.Bucket(this, 'bucket'),
    key: 'truststore.pem',
    version: 'version',
  },
});

Properties

Name	Type	Description
certificate	`ICertificate`	The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name.
domainName	`string`	The custom domain name for your API.
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.
endpointType?	`EndpointType`	The type of endpoint for this DomainName.
mapping?	`IRestApi`	If specified, all requests to this domain will be mapped to the production deployment of this API.
mtls?	`MTLSConfig`	The mutual TLS authentication configuration for a custom domain name.
securityPolicy?	`SecurityPolicy`	The Transport Layer Security (TLS) version + cipher suite for this domain name.

certificate

Type: 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.

domainName

Type: string

The custom domain name for your API.

Uppercase letters are not supported.

basePath?

Type: string (optional, 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.)

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.

endpointType?

Type: EndpointType (optional, default: REGIONAL)

The type of endpoint for this DomainName.

mapping?

Type: IRestApi (optional, default: you will have to call addBasePathMapping to map this domain to API endpoints.)

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, don't specify this option and use addBasePathMapping.

mtls?

Type: MTLSConfig (optional, default: mTLS is not configured.)

The mutual TLS authentication configuration for a custom domain name.

securityPolicy?

Type: SecurityPolicy (optional, default: SecurityPolicy.TLS_1_0)

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