domain_name_access_associations

Creates, updates, deletes or gets a domain_name_access_association resource or lists domain_name_access_associations in a region

Overview

Name	domain_name_access_associations
Type	Resource
Description	Resource Type definition for AWS::ApiGateway::DomainNameAccessAssociation.
Id	aws.apigateway.domain_name_access_associations

Fields

Name	Datatype	Description
domain_name_access_association_arn	string	The amazon resource name (ARN) of the domain name access association resource.
domain_name_arn	string	The amazon resource name (ARN) of the domain name resource.
access_association_source	string	The source of the domain name access association resource.
access_association_source_type	string	The source type of the domain name access association resource.
tags	array	An array of arbitrary tags (key-value pairs) to associate with the domainname access association.
region	string	AWS region.

For more information, see AWS::ApiGateway::DomainNameAccessAssociation.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DomainNameArn, AccessAssociationSource, AccessAssociationSourceType, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all domain_name_access_associations in a region.

SELECT
region,
domain_name_access_association_arn,
domain_name_arn,
access_association_source,
access_association_source_type,
tags
FROM aws.apigateway.domain_name_access_associations
WHERE region = 'us-east-1';

Gets all properties from an individual domain_name_access_association.

SELECT
region,
domain_name_access_association_arn,
domain_name_arn,
access_association_source,
access_association_source_type,
tags
FROM aws.apigateway.domain_name_access_associations
WHERE region = 'us-east-1' AND data__Identifier = '<DomainNameAccessAssociationArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.apigateway.domain_name_access_associations (
 DomainNameArn,
 AccessAssociationSource,
 AccessAssociationSourceType,
 region
)
SELECT 
'{{ DomainNameArn }}',
 '{{ AccessAssociationSource }}',
 '{{ AccessAssociationSourceType }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.apigateway.domain_name_access_associations (
 DomainNameArn,
 AccessAssociationSource,
 AccessAssociationSourceType,
 Tags,
 region
)
SELECT 
 '{{ DomainNameArn }}',
 '{{ AccessAssociationSource }}',
 '{{ AccessAssociationSourceType }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: domain_name_access_association
    props:
      - name: DomainNameArn
        value: '{{ DomainNameArn }}'
      - name: AccessAssociationSource
        value: '{{ AccessAssociationSource }}'
      - name: AccessAssociationSourceType
        value: '{{ AccessAssociationSourceType }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM aws.apigateway.domain_name_access_associations
WHERE data__Identifier = '<DomainNameAccessAssociationArn>'
AND region = 'us-east-1';

Permissions

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

Create

apigateway:POST,
apigateway:GET

Read

apigateway:GET

Delete

apigateway:DELETE,
apigateway:GET

List

apigateway:GET