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	awscc.apigateway.domain_name_access_associations

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
domain_name_access_association_arn	string	The amazon resource name (ARN) of the domain name access association resource.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	domain_name_access_associations	INSERT	DomainNameArn, AccessAssociationSource, AccessAssociationSourceType, region
delete_resource	domain_name_access_associations	DELETE	Identifier, region
list_resources	domain_name_access_associations_list_only	SELECT	region
get_resource	domain_name_access_associations	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.apigateway.domain_name_access_associations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_name_access_association_arn }}';

list (identifiers only)

Lists all domain_name_access_associations in a region.

SELECT
  region,
  domain_name_access_association_arn
FROM awscc.apigateway.domain_name_access_associations_list_only
WHERE
  region = '{{ region }}';

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 awscc.apigateway.domain_name_access_associations (
  DomainNameArn,
  AccessAssociationSource,
  AccessAssociationSourceType,
  region
)
SELECT
  '{{ domain_name_arn }}',
  '{{ access_association_source }}',
  '{{ access_association_source_type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.apigateway.domain_name_access_associations (
  DomainNameArn,
  AccessAssociationSource,
  AccessAssociationSourceType,
  Tags,
  region
)
SELECT
  '{{ domain_name_arn }}',
  '{{ access_association_source }}',
  '{{ access_association_source_type }}',
  '{{ tags }}',
  '{{ 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_access_association
  props:
    - name: domain_name_arn
      value: '{{ domain_name_arn }}'
    - name: access_association_source
      value: '{{ access_association_source }}'
    - name: access_association_source_type
      value: '{{ access_association_source_type }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'

DELETE example

/*+ delete */
DELETE FROM awscc.apigateway.domain_name_access_associations
WHERE
  Identifier = '{{ domain_name_access_association_arn }}' 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_access_associations resource, the following permissions are required:

Create

apigateway:POST,
apigateway:GET

Read

apigateway:GET

Delete

apigateway:DELETE,
apigateway:GET

List

apigateway:GET