hosted_zone_associations

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

Overview

Name	hosted_zone_associations
Type	Resource
Id	aws.route53globalresolver.hosted_zone_associations

Fields

The following fields are returned by SELECT queries:

get_hosted_zone_association

Name	Datatype	Description
id	string	ID of the private hosted zone association. (pattern: <code>[-.a-zA-Z0-9]+</code>)
name	string	Name of the private hosted zone association. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)</code>)
created_at	string (date-time)	The time and date the private hosted zone association was created.
hosted_zone_id	string	ID of the hosted zone associated to the DNS view.
hosted_zone_name	string	Name of the domain associated with the private hosted zone.
resource_arn	string	Amazon Resource Name (ARN) of the DNS view the private hosted zone is associated to. (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>)
status	string	The operational status of the private hosted zone association. (CREATING, OPERATIONAL, DELETING)
updated_at	string (date-time)	The time and date the private hosted zone association was updated.

list_hosted_zone_associations

Name	Datatype	Description
id	string	The unique identifier of the hosted zone association. (pattern: <code>[-.a-zA-Z0-9]+</code>)
name	string	The name of the hosted zone association. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)</code>)
created_at	string (date-time)	The date and time when the hosted zone association was created.
hosted_zone_id	string	The ID of the hosted zone.
hosted_zone_name	string	The name of the hosted zone.
resource_arn	string	The Amazon Resource Name (ARN) of the resource associated with the hosted zone. (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>)
status	string	The current status of the hosted zone association. (CREATING, OPERATIONAL, DELETING)
updated_at	string (date-time)	The date and time when the hosted zone association was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_hosted_zone_association	select	hosted_zone_association_id, region		Retrieves information about a hosted zone association. 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_hosted_zone_associations	select	region	max_results, next_token, resourceArn	Lists hosted zone associations with pagination support. Specify a DNS view through the resourceArn parameter to list the hosted zone associations for that DNS view, or omit it to list all hosted zone associations in your Amazon Web Services account. 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_hosted_zone_association	update	hosted_zone_association_id, region		Updates the configuration of a hosted zone association. 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
hosted_zone_association_id	string	The ID of the private hosted zone association.
region	string	AWS region (default: us-east-1)
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.
resourceArn	string	The Amazon Resource Name (ARN) of the DNS view to list hosted zone associations for. This parameter is optional; if you omit it, all hosted zone associations in your Amazon Web Services account are returned.

SELECT examples

get_hosted_zone_association

Retrieves information about a hosted zone association. 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,
created_at,
hosted_zone_id,
hosted_zone_name,
resource_arn,
status,
updated_at
FROM aws.route53globalresolver.hosted_zone_associations
WHERE hosted_zone_association_id = '{{ hosted_zone_association_id }}' -- required
AND region = '{{ region }}' -- required
;

list_hosted_zone_associations

Lists hosted zone associations with pagination support. Specify a DNS view through the resourceArn parameter to list the hosted zone associations for that DNS view, or omit it to list all hosted zone associations in your Amazon Web Services account. 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,
created_at,
hosted_zone_id,
hosted_zone_name,
resource_arn,
status,
updated_at
FROM aws.route53globalresolver.hosted_zone_associations
WHERE region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND next_token = '{{ next_token }}'
AND resourceArn = '{{ resourceArn }}'
;

UPDATE examples

update_hosted_zone_association

Updates the configuration of a hosted zone association. 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.hosted_zone_associations
SET 
name = '{{ name }}'
WHERE 
hosted_zone_association_id = '{{ hosted_zone_association_id }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
created_at,
hosted_zone_id,
hosted_zone_name,
resource_arn,
status,
updated_at;