AWS Fundamentals Logo
AWS Fundamentals
AWS::AppSync::DomainNameApiAssociation

AppSync DomainNameApiAssociation

Resource Type definition for AWS::AppSync::DomainNameApiAssociation

Properties

2 configurable properties. 2 required. Click a row to see details.

Filter:
PropertyTypeFlags
ApiId
string
Required
DomainName
string
RequiredCreate-only

Return Values

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

AttributeTypeDescription
ApiAssociationIdentifierstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::AppSync::DomainNameApiAssociation

Resources:
  MyResource:
    Type: AWS::AppSync::DomainNameApiAssociation
    Properties:
      DomainName: "my-domainname"
      ApiId: "my-apiid"

Required IAM Permissions

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

create

appsync:AssociateApiappsync:GetApiAssociation

delete

appsync:DisassociateApiappsync:GetApiAssociation

update

appsync:AssociateApiappsync:GetApiAssociation

read

appsync:GetApiAssociation

Get the AppSync Cheat Sheet

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

Download Free Infographic

Quick Facts

ServiceAppSync
Properties3
Required2
TaggingNot supported
Primary IDApiAssociationIdentifier

Supported Operations

CreateDeleteUpdateRead

Immutable After Creation

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

DomainName

External Links