interface DomainNameConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Apigatewayv2.CfnDomainName.DomainNameConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnDomainName_DomainNameConfigurationProperty`
Java	`software.amazon.awscdk.services.apigatewayv2.CfnDomainName.DomainNameConfigurationProperty`
Python	`aws_cdk.aws_apigatewayv2.CfnDomainName.DomainNameConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_apigatewayv2` » `CfnDomainName` » `DomainNameConfigurationProperty`

The DomainNameConfiguration property type specifies the configuration for an API's domain name.

DomainNameConfiguration is a property of the AWS::ApiGatewayV2::DomainName resource.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const domainNameConfigurationProperty: apigatewayv2.CfnDomainName.DomainNameConfigurationProperty = {
  certificateArn: 'certificateArn',
  certificateName: 'certificateName',
  endpointType: 'endpointType',
  ipAddressType: 'ipAddressType',
  ownershipVerificationCertificateArn: 'ownershipVerificationCertificateArn',
  securityPolicy: 'securityPolicy',
};

Properties

Name	Type	Description
certificateArn?	`string`	An AWS -managed certificate that will be used by the edge-optimized endpoint for this domain name.
certificateName?	`string`	The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
endpointType?	`string`	The endpoint type.
ipAddressType?	`string`	The IP address types that can invoke the domain name.
ownershipVerificationCertificateArn?	`string`	The Amazon resource name (ARN) for the public certificate issued by Certificate Manager .
securityPolicy?	`string`	The Transport Layer Security (TLS) version of the security policy for this domain name.

certificateArn?

Type: string (optional)

An AWS -managed certificate that will be used by the edge-optimized endpoint for this domain name.

AWS Certificate Manager is the only supported source.

certificateName?

Type: string (optional)

The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

endpointType?

Type: string (optional)

The endpoint type.

ipAddressType?

Type: string (optional)

The IP address types that can invoke the domain name.

Use ipv4 to allow only IPv4 addresses to invoke your domain name, or use dualstack to allow both IPv4 and IPv6 addresses to invoke your domain name.

ownershipVerificationCertificateArn?

Type: string (optional)

The Amazon resource name (ARN) for the public certificate issued by Certificate Manager .

This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.

securityPolicy?

Type: string (optional)

The Transport Layer Security (TLS) version of the security policy for this domain name.

The valid values are TLS_1_0 and TLS_1_2 .