View a markdown version of this page

AWS::EC2::VPCEndpointService PrivateDnsNameConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::EC2::VPCEndpointService PrivateDnsNameConfiguration

Information about the private DNS name for the service endpoint.

Syntax

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

JSON

{
  "Name" : String,
  "State" : String,
  "Type" : String,
  "Value" : String
}

YAML

  Name: String
  State: String
  Type: String
  Value: String

Properties

Name

The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name.

Required: No

Type: String

Update requires: No interruption

State

The verification state of the VPC endpoint service.

Consumers of the endpoint service can use the private name only when the state is verified.

Required: No

Type: String

Allowed values: pendingVerification | verified | failed

Update requires: No interruption

Type

The endpoint service verification type, for example TXT.

Required: No

Type: String

Update requires: No interruption

Value

The value the service provider adds to the private DNS name domain record before verification.

Required: No

Type: String

Update requires: No interruption