reusable_delegation_sets

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

Overview

Name	reusable_delegation_sets
Type	Resource
Id	aws.route53.reusable_delegation_sets

Fields

The following fields are returned by SELECT queries:

get_reusable_delegation_set

Name	Datatype	Description
caller_reference	string	The value that you specified for CallerReference when you created the reusable delegation set.
id	string	The ID that Amazon Route 53 assigns to a reusable delegation set.
name_servers	string	A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.

list_reusable_delegation_sets

Name	Datatype	Description
caller_reference	string	The value that you specified for CallerReference when you created the reusable delegation set.
id	string	The ID that Amazon Route 53 assigns to a reusable delegation set.
name_servers	string	A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_reusable_delegation_set	select	id, region		Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.
list_reusable_delegation_sets	select	region	marker, maxitems	Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.
create_reusable_delegation_set	insert	region, CallerReference		Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same Amazon Web Services account. You can also create a reusable delegation set that uses the four name servers that are associated with an existing hosted zone. Specify the hosted zone ID in the CreateReusableDelegationSet request. You can't associate a reusable delegation set with a private hosted zone. For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers. The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps: Create a reusable delegation set. Recreate hosted zones, and reduce the TTL to 60 seconds or less. Recreate resource record sets in the new hosted zones. Change the registrar's name servers to use the name servers for the new hosted zones. Monitor traffic for the website or application. Change TTLs back to their original values. If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following: For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones. For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set. For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set.
delete_reusable_delegation_set	delete	id, region		Deletes a reusable delegation set. You can delete a reusable delegation set only if it isn't associated with any hosted zones. To verify that the reusable delegation set is not associated with any hosted zones, submit a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete.

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
id	string	The ID of the reusable delegation set that you want to delete.
region	string	AWS region (default: us-east-1)
marker	string	If the value of IsTruncated in the previous response was true, you have more reusable delegation sets. To get another group, submit another ListReusableDelegationSets request. For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first reusable delegation set that Amazon Route 53 will return if you submit another request. If the value of IsTruncated in the previous response was false, there are no more reusable delegation sets to get.
maxitems	string	The number of reusable delegation sets that you want Amazon Route 53 to return in the response to this request. If you specify a value greater than 100, Route 53 returns only the first 100 reusable delegation sets.

SELECT examples

get_reusable_delegation_set

Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.

SELECT
caller_reference,
id,
name_servers
FROM aws.route53.reusable_delegation_sets
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_reusable_delegation_sets

Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.

SELECT
caller_reference,
id,
name_servers
FROM aws.route53.reusable_delegation_sets
WHERE region = '{{ region }}' -- required
AND marker = '{{ marker }}'
AND maxitems = '{{ maxitems }}'
;

INSERT examples

create_reusable_delegation_set

Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same Amazon Web Services account. You can also create a reusable delegation set that uses the four name servers that are associated with an existing hosted zone. Specify the hosted zone ID in the CreateReusableDelegationSet request. You can't associate a reusable delegation set with a private hosted zone. For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers. The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps: Create a reusable delegation set. Recreate hosted zones, and reduce the TTL to 60 seconds or less. Recreate resource record sets in the new hosted zones. Change the registrar's name servers to use the name servers for the new hosted zones. Monitor traffic for the website or application. Change TTLs back to their original values. If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following: For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones. For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set. For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set.

INSERT INTO aws.route53.reusable_delegation_sets (
CallerReference,
HostedZoneId,
region
)
SELECT 
'{{ CallerReference }}' /* required */,
'{{ HostedZoneId }}',
'{{ region }}'
RETURNING
delegation_set,
location
;

Manifest

# Description fields are for documentation purposes
- name: reusable_delegation_sets
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the reusable_delegation_sets resource.
  - name: CallerReference
    value: "{{ CallerReference }}"
  - name: HostedZoneId
    value: "{{ HostedZoneId }}"

DELETE examples

delete_reusable_delegation_set

Deletes a reusable delegation set. You can delete a reusable delegation set only if it isn't associated with any hosted zones. To verify that the reusable delegation set is not associated with any hosted zones, submit a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete.

DELETE FROM aws.route53.reusable_delegation_sets
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;