access_sources

Creates, updates, deletes, gets or lists an access_sources resource.

Overview

Name	access_sources
Type	Resource
Id	aws.route53globalresolver.access_sources

Fields

The following fields are returned by SELECT queries:

get_access_source

Name	Datatype	Description
id	string	ID for the rule. (pattern: <code>[-.a-zA-Z0-9]+</code>)
name	string	Name for the access source. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)</code>)
arn	string	The Amazon Resource Name (ARN) of the access source. (pattern: <code>arn:[-.a-z0-9]{1,63}:[-.a-z0-9]{1,63}:[-.a-z0-9]{0,63}:[-.a-z0-9]{0,63}:[^/].{0,1023}</code>)
cidr	string	The IP range for the rule's parameters in CIDR notation.
created_at	string (date-time)	The time and date the rule was created.
dns_view_id	string	ID for the DNS view that the rule is associated to. (pattern: <code>[-.a-zA-Z0-9]+</code>)
ip_address_type	string	The IP address type. (IPV4, IPV6)
protocol	string	The protocol determines how data is transmitted to a Global Resolver instance. (DO53, DOH, DOT)
status	string	Information about the status of the rule. (CREATING, OPERATIONAL, UPDATING, DELETING)
updated_at	string (date-time)	The time and date the access source was updated.

list_access_sources

Name	Datatype	Description
id	string	The unique identifier of the access source. (pattern: <code>[-.a-zA-Z0-9]+</code>)
name	string	The name of the access source. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)</code>)
arn	string	The Amazon Resource Name (ARN) of the access source. (pattern: <code>arn:[-.a-z0-9]{1,63}:[-.a-z0-9]{1,63}:[-.a-z0-9]{0,63}:[-.a-z0-9]{0,63}:[^/].{0,1023}</code>)
cidr	string	The CIDR block that defines the IP address range for the access source.
created_at	string (date-time)	The date and time when the access source was created.
dns_view_id	string	The ID of the DNS view that the access source is associated with. (pattern: <code>[-.a-zA-Z0-9]+</code>)
ip_address_type	string	The IP address type of the access source. (IPV4, IPV6)
protocol	string	The protocol used by the access source. (DO53, DOH, DOT)
status	string	The current status of the access source. (CREATING, OPERATIONAL, UPDATING, DELETING)
updated_at	string (date-time)	The date and time when the access source was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_access_source	select	access_source_id, region		Retrieves information about an access source. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.
list_access_sources	select	region	max_results, next_token, filters	Lists all access sources with pagination support. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.
create_access_source	insert	region, cidr, dnsViewId, protocol		Creates an access source for a DNS view. Access sources define IP addresses or CIDR ranges that are allowed to send DNS queries to the Route 53 Global Resolver, along with the permitted DNS protocols. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.
update_access_source	update	access_source_id, region		Updates the configuration of an access source. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.
delete_access_source	delete	access_source_id, region		Deletes an access source. This operation cannot be undone. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.

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
access_source_id	string	The unique identifier of the access source to delete.
region	string	AWS region (default: us-east-1)
filters	object	Values to filter the results.
max_results	integer	The maximum number of results to retrieve in a single call.
next_token	string	A pagination token used for large sets of results that can't be returned in a single response.

SELECT examples

get_access_source

Retrieves information about an access source. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.

SELECT
id,
name,
arn,
cidr,
created_at,
dns_view_id,
ip_address_type,
protocol,
status,
updated_at
FROM aws.route53globalresolver.access_sources
WHERE access_source_id = '{{ access_source_id }}' -- required
AND region = '{{ region }}' -- required
;

list_access_sources

Lists all access sources with pagination support. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.

SELECT
id,
name,
arn,
cidr,
created_at,
dns_view_id,
ip_address_type,
protocol,
status,
updated_at
FROM aws.route53globalresolver.access_sources
WHERE region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND next_token = '{{ next_token }}'
AND filters = '{{ filters }}'
;

INSERT examples

create_access_source

Creates an access source for a DNS view. Access sources define IP addresses or CIDR ranges that are allowed to send DNS queries to the Route 53 Global Resolver, along with the permitted DNS protocols. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.

INSERT INTO aws.route53globalresolver.access_sources (
cidr,
clientToken,
ipAddressType,
name,
dnsViewId,
protocol,
tags,
region
)
SELECT 
'{{ cidr }}' /* required */,
'{{ clientToken }}',
'{{ ipAddressType }}',
'{{ name }}',
'{{ dnsViewId }}' /* required */,
'{{ protocol }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
id,
name,
arn,
cidr,
created_at,
dns_view_id,
ip_address_type,
protocol,
status,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: access_sources
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the access_sources resource.
  - name: cidr
    value: "{{ cidr }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: ipAddressType
    value: "{{ ipAddressType }}"
    valid_values: ['IPV4', 'IPV6']
  - name: name
    value: "{{ name }}"
  - name: dnsViewId
    value: "{{ dnsViewId }}"
  - name: protocol
    value: "{{ protocol }}"
    valid_values: ['DO53', 'DOH', 'DOT']
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_access_source

Updates the configuration of an access source. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.

UPDATE aws.route53globalresolver.access_sources
SET 
cidr = '{{ cidr }}',
ipAddressType = '{{ ipAddressType }}',
name = '{{ name }}',
protocol = '{{ protocol }}'
WHERE 
access_source_id = '{{ access_source_id }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
arn,
cidr,
created_at,
dns_view_id,
ip_address_type,
protocol,
status,
updated_at;

DELETE examples

delete_access_source

Deletes an access source. This operation cannot be undone. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.

DELETE FROM aws.route53globalresolver.access_sources
WHERE access_source_id = '{{ access_source_id }}' --required
AND region = '{{ region }}' --required
;