AWS CloudFormation
User Guide (Version )

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

AWS::ApiGatewayV2::DomainName DomainNameConfiguration

The DomainNameConfiguration property type specifies the configuration for a WebSocket's domain name.

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "CertificateArn" : String, "CertificateName" : String, "EndpointType" : String }

YAML

CertificateArn: String CertificateName: String EndpointType: String

Properties

CertificateArn

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.

Required: No

Type: String

Update requires: No interruption

CertificateName

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

Required: No

Type: String

Update requires: No interruption

EndpointType

The endpoint type.

Required: No

Type: String

Update requires: No interruption

See Also

On this page: