source_api_associations

Creates, updates, deletes or gets a source_api_association resource or lists source_api_associations in a region

Overview

Name	source_api_associations
Type	Resource
Description	Resource Type definition for AWS::AppSync::SourceApiAssociation
Id	aws.appsync.source_api_associations

Fields

Name	Datatype	Description
source_api_identifier	string	Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
merged_api_identifier	string	Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
description	string	Description of the SourceApiAssociation.
source_api_association_config	undefined	Customized configuration for SourceApiAssociation.
association_id	string	Id of the SourceApiAssociation.
association_arn	string	ARN of the SourceApiAssociation.
source_api_id	string	GraphQLApiId of the source API in the association.
source_api_arn	string	ARN of the source API in the association.
merged_api_id	string	GraphQLApiId of the Merged API in the association.
merged_api_arn	string	ARN of the Merged API in the association.
source_api_association_status	string	Current status of SourceApiAssociation.
source_api_association_status_detail	string	Current SourceApiAssociation status details.
last_successful_merge_date	string	Date of last schema successful merge.
region	string	AWS region.

Methods

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

SELECT examples

Gets all source_api_associations in a region.

SELECT
region,
source_api_identifier,
merged_api_identifier,
description,
source_api_association_config,
association_id,
association_arn,
source_api_id,
source_api_arn,
merged_api_id,
merged_api_arn,
source_api_association_status,
source_api_association_status_detail,
last_successful_merge_date
FROM aws.appsync.source_api_associations
WHERE region = 'us-east-1';

Gets all properties from an individual source_api_association.

SELECT
region,
source_api_identifier,
merged_api_identifier,
description,
source_api_association_config,
association_id,
association_arn,
source_api_id,
source_api_arn,
merged_api_id,
merged_api_arn,
source_api_association_status,
source_api_association_status_detail,
last_successful_merge_date
FROM aws.appsync.source_api_associations
WHERE region = 'us-east-1' AND data__Identifier = '<AssociationArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.appsync.source_api_associations (
 SourceApiIdentifier,
 MergedApiIdentifier,
 Description,
 SourceApiAssociationConfig,
 region
)
SELECT 
'{{ SourceApiIdentifier }}',
 '{{ MergedApiIdentifier }}',
 '{{ Description }}',
 '{{ SourceApiAssociationConfig }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.appsync.source_api_associations (
 SourceApiIdentifier,
 MergedApiIdentifier,
 Description,
 SourceApiAssociationConfig,
 region
)
SELECT 
 '{{ SourceApiIdentifier }}',
 '{{ MergedApiIdentifier }}',
 '{{ Description }}',
 '{{ SourceApiAssociationConfig }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: source_api_association
    props:
      - name: SourceApiIdentifier
        value: '{{ SourceApiIdentifier }}'
      - name: MergedApiIdentifier
        value: '{{ MergedApiIdentifier }}'
      - name: Description
        value: '{{ Description }}'
      - name: SourceApiAssociationConfig
        value: null

DELETE example

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

Permissions

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

Create

appsync:AssociateSourceGraphqlApi,
appsync:AssociateMergedGraphqlApi,
appsync:GetSourceApiAssociation

Read

appsync:GetSourceApiAssociation,
appsync:ListSourceApiAssociations

Update

appsync:GetSourceApiAssociation,
appsync:UpdateSourceApiAssociation,
appsync:GetSourceApiAssociation

Delete

appsync:GetSourceApiAssociation,
appsync:DisassociateSourceGraphqlApi,
appsync:DisassociateMergedGraphqlApi,
appsync:ListSourceApiAssociations

List

appsync:ListSourceApiAssociations