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	awscc.appsync.domain_name_api_associations

Fields

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

For more information, see AWS::AppSync::DomainNameApiAssociation.

Methods

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

SELECT examples

Gets all properties from an individual domain_name_api_association.

SELECT
  region,
  domain_name,
  api_id,
  api_association_identifier
FROM awscc.appsync.domain_name_api_associations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ api_association_identifier }}';

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 awscc.appsync.domain_name_api_associations (
  DomainName,
  ApiId,
  region
)
SELECT
  '{{ domain_name }}',
  '{{ api_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.appsync.domain_name_api_associations (
  DomainName,
  ApiId,
  region
)
SELECT
  '{{ domain_name }}',
  '{{ api_id }}',
  '{{ 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: domain_name
        value: '{{ domain_name }}'
      - name: api_id
        value: '{{ api_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.appsync.domain_name_api_associations
SET PatchDocument = string('{{ {
    "ApiId": api_id
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ api_association_identifier }}';

DELETE example

/*+ delete */
DELETE FROM awscc.appsync.domain_name_api_associations
WHERE
  Identifier = '{{ api_association_identifier }}' 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