aws-cdk-lib.aws_apigateway.CfnDomainNameProps

interface CfnDomainNameProps

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

Properties for defining a CfnDomainName.

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 cfnDomainNameProps: apigateway.CfnDomainNameProps = {
  certificateArn: 'certificateArn',
  domainName: 'domainName',
  endpointConfiguration: {
    types: ['types'],
  },
  mutualTlsAuthentication: {
    truststoreUri: 'truststoreUri',
    truststoreVersion: 'truststoreVersion',
  },
  ownershipVerificationCertificateArn: 'ownershipVerificationCertificateArn',
  regionalCertificateArn: 'regionalCertificateArn',
  securityPolicy: 'securityPolicy',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
certificateArn?stringThe reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.
domainName?stringThe custom domain name as an API host name, for example, my-api.example.com .
endpointConfiguration?IResolvable | EndpointConfigurationPropertyThe endpoint configuration of this DomainName showing the endpoint types of the domain name.
mutualTlsAuthentication?IResolvable | MutualTlsAuthenticationPropertyThe mutual TLS authentication configuration for a custom domain name.
ownershipVerificationCertificateArn?stringThe ARN of the public certificate issued by ACM to validate ownership of your custom domain.
regionalCertificateArn?stringThe reference to an AWS -managed certificate that will be used for validating the regional domain name.
securityPolicy?stringThe 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.