AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGateway::DomainNameV2

ApiGateway DomainNameV2

Resource Type definition for AWS::ApiGateway::DomainNameV2.

Properties

8 configurable properties. Click a row to see details.

Filter:
PropertyTypeFlags
CertificateArn
string
DomainName
string
Create-only
EndpointAccessMode
string
EndpointConfiguration
EndpointConfiguration
Create-only
Policy
objectstring
RoutingMode
string
SecurityPolicy
string
Create-only
Tags
Array<Tag>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
DomainNameArnstringThe amazon resource name (ARN) of the domain name resource.
DomainNameIdstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ApiGateway::DomainNameV2

Resources:
  MyResource:
    Type: AWS::ApiGateway::DomainNameV2
    Properties:
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

apigateway:POSTapigateway:GETapigateway:UpdateDomainNamePolicy

read

apigateway:GET

update

apigateway:GETapigateway:PUTapigateway:PATCHapigateway:UpdateDomainNamePolicy

delete

apigateway:DELETEapigateway:GETapigateway:UpdateDomainNamePolicy

list

apigateway:GET

Get the ApiGateway Cheat Sheet

Everything you need to know about ApiGateway on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceApiGateway
Properties10
Required0
TaggingSupported
Primary IDDomainNameArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DomainNameSecurityPolicyEndpointConfiguration

Related Resources

External Links