interface CfnDomainNameProps

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

Properties for defining a CfnDomainName.

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

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: {
    ipAddressType: 'ipAddressType',
    types: ['types'],
  },
  mutualTlsAuthentication: {
    truststoreUri: 'truststoreUri',
    truststoreVersion: 'truststoreVersion',
  },
  ownershipVerificationCertificateArn: 'ownershipVerificationCertificateArn',
  regionalCertificateArn: 'regionalCertificateArn',
  routingMode: 'routingMode',
  securityPolicy: 'securityPolicy',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
certificateArn?	string	The reference to an AWS -managed certificate that will be used by edge-optimized endpoint or private 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 and IP address 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.
routingMode?	string	The routing mode for this 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 or private endpoint for this domain name.

Certificate Manager is the only supported source.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn

---

domainName?

Type: string (optional)

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

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

---

endpointConfiguration?

Type: IResolvable | EndpointConfigurationProperty (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointconfiguration

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn

---

regionalCertificateArn?

Type: string (optional)

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

Certificate Manager is the only supported source.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn

---

routingMode?

Type: string (optional, default: "BASE_PATH_MAPPING_ONLY")

The routing mode for this domain name.

The routing mode determines how API Gateway sends traffic from your custom domain name to your public APIs.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-routingmode

---

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy

---

tags?

Type: CfnTag[] (optional)

The collection of tags.

Each tag element is associated with a given resource.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-tags