domain_name_access_associations

Creates, updates, deletes, gets or lists a domain_name_access_associations resource.

Overview

Name	domain_name_access_associations
Type	Resource
Id	aws.apigateway.domain_name_access_associations

Fields

The following fields are returned by SELECT queries:

get_domain_name_access_associations

Name	Datatype	Description
items_	array	The current page of elements from this collection.
position	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_domain_name_access_associations	select	region	position, limit, resourceOwner	Represents a collection on DomainNameAccessAssociations resources.
create_domain_name_access_association	insert	region, domainNameArn, accessAssociationSourceType, accessAssociationSource		Creates a domain name access association resource between an access association source and a private custom domain name.
delete_domain_name_access_association	delete	domain_name_access_association_arn, region		Deletes the DomainNameAccessAssociation resource. Only the AWS account that created the DomainNameAccessAssociation resource can delete it. To stop an access association source in another AWS account from accessing your private custom domain name, use the RejectDomainNameAccessAssociation operation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_name_access_association_arn	string	The ARN of the domain name access association resource.
region	string	AWS region (default: us-east-1)
limit	integer	The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
position	string	The current pagination position in the paged result set.
resourceOwner	string	The owner of the domain name access association. Use SELF to only list the domain name access associations owned by your own account. Use OTHER_ACCOUNTS to list the domain name access associations with your private custom domain names that are owned by other AWS accounts.

SELECT examples

get_domain_name_access_associations

Represents a collection on DomainNameAccessAssociations resources.

SELECT
items_,
position
FROM aws.apigateway.domain_name_access_associations
WHERE region = '{{ region }}' -- required
AND position = '{{ position }}'
AND limit = '{{ limit }}'
AND resourceOwner = '{{ resourceOwner }}'
;

INSERT examples

create_domain_name_access_association

Creates a domain name access association resource between an access association source and a private custom domain name.

INSERT INTO aws.apigateway.domain_name_access_associations (
domainNameArn,
accessAssociationSourceType,
accessAssociationSource,
tags,
region
)
SELECT 
'{{ domainNameArn }}' /* required */,
'{{ accessAssociationSourceType }}' /* required */,
'{{ accessAssociationSource }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
access_association_source,
access_association_source_type,
domain_name_access_association_arn,
domain_name_arn,
tags
;

Manifest

# Description fields are for documentation purposes
- name: domain_name_access_associations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the domain_name_access_associations resource.
  - name: domainNameArn
    value: "{{ domainNameArn }}"
  - name: accessAssociationSourceType
    value: "{{ accessAssociationSourceType }}"
    valid_values: ['VPCE']
  - name: accessAssociationSource
    value: "{{ accessAssociationSource }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_domain_name_access_association

Deletes the DomainNameAccessAssociation resource. Only the AWS account that created the DomainNameAccessAssociation resource can delete it. To stop an access association source in another AWS account from accessing your private custom domain name, use the RejectDomainNameAccessAssociation operation.

DELETE FROM aws.apigateway.domain_name_access_associations
WHERE domain_name_access_association_arn = '{{ domain_name_access_association_arn }}' --required
AND region = '{{ region }}' --required
;