AWS::ApiGateway::DomainNameAccessAssociation

ApiGateway DomainNameAccessAssociation

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

Properties

4 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`AccessAssociationSource`	`string`	RequiredCreate-only
`AccessAssociationSourceType`	`string`	RequiredCreate-only
`DomainNameArn`	`string`	RequiredCreate-only
`Tags`	`Array<Tag>`	Create-only

Return Values

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

Attribute	Type	Description
`DomainNameAccessAssociationArn`	`string`	The amazon resource name (ARN) of the domain name access association resource.

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::DomainNameAccessAssociation

Resources:
  MyResource:
    Type: AWS::ApiGateway::DomainNameAccessAssociation
    Properties:
      DomainNameArn: "arn:aws:service:region:account:resource"
      AccessAssociationSource: "value"
      AccessAssociationSourceType: "VPCE"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

apigateway:POSTapigateway:GET

read

apigateway:GET

delete

apigateway:DELETEapigateway:GET

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

Properties5

Required3

TaggingSupported

Primary IDDomainNameAccessAssociationArn

Supported Operations

CreateReadDeleteList

Immutable After Creation

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

DomainNameArnAccessAssociationSourceAccessAssociationSourceTypeTags

Related Resources

External Links

AWS Documentation