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 = '{{ region }}' 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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.appsync.domain_name_api_associations (
  DomainName,
  ApiId,
  region
)
SELECT
  '{{ domain_name }}',
  '{{ api_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.appsync.domain_name_api_associations
WHERE
  Identifier = '{{ api_association_identifier }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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