domain_name_api_associations

Creates, updates, deletes or gets a domain_name_api_association resource or lists domain_name_api_associations in a region

Overview

Name	domain_name_api_associations
Type	Resource
Description	Resource Type definition for AWS::AppSync::DomainNameApiAssociation
Id	aws.appsync.domain_name_api_associations

Fields

Name	Datatype	Description
domain_name	string
api_id	string
api_association_identifier	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DomainName, ApiId, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual domain_name_api_association.

SELECT
region,
domain_name,
api_id,
api_association_identifier
FROM aws.appsync.domain_name_api_associations
WHERE region = 'us-east-1' AND data__Identifier = '<ApiAssociationIdentifier>';

INSERT example

Use the following StackQL query and manifest file to create a new domain_name_api_association resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.appsync.domain_name_api_associations (
 DomainName,
 ApiId,
 region
)
SELECT 
'{{ DomainName }}',
 '{{ ApiId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.appsync.domain_name_api_associations (
 DomainName,
 ApiId,
 region
)
SELECT 
 '{{ DomainName }}',
 '{{ ApiId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: domain_name_api_association
    props:
      - name: DomainName
        value: '{{ DomainName }}'
      - name: ApiId
        value: '{{ ApiId }}'

DELETE example

/*+ delete */
DELETE FROM aws.appsync.domain_name_api_associations
WHERE data__Identifier = '<ApiAssociationIdentifier>'
AND region = 'us-east-1';

Permissions

To operate on the domain_name_api_associations resource, the following permissions are required:

Create

appsync:AssociateApi,
appsync:GetApiAssociation

Delete

appsync:DisassociateApi,
appsync:GetApiAssociation

Update

appsync:AssociateApi,
appsync:GetApiAssociation

Read

appsync:GetApiAssociation