aws-cdk-lib.aws_apigateway.DomainNameProps

interface DomainNameProps

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.DomainNameProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#DomainNameProps
Javasoftware.amazon.awscdk.services.apigateway.DomainNameProps
Pythonaws_cdk.aws_apigateway.DomainNameProps
TypeScript (source)aws-cdk-lib » aws_apigateway » DomainNameProps

Example

declare const acmCertificateForExampleCom: any;
declare const restApi: apigateway.RestApi;

new apigateway.DomainName(this, 'custom-domain', {
  domainName: 'example.com',
  certificate: acmCertificateForExampleCom,
  mapping: restApi,
  basePath: 'orders/v1/api',
});

Properties

NameTypeDescription
certificateICertificateThe reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name.
domainNamestringThe custom domain name for your API.
basePath?stringThe 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?EndpointTypeThe type of endpoint for this DomainName.
mapping?IRestApiIf specified, all requests to this domain will be mapped to the production deployment of this API.
mtls?MTLSConfigThe mutual TLS authentication configuration for a custom domain name.
securityPolicy?SecurityPolicyThe 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).)

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, use addBasePathMapping or addApiMapping.


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_2)

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

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html