profiles

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

Overview

Name	profiles
Type	Resource
Id	aws.route53profiles.profiles

Fields

The following fields are returned by SELECT queries:

get_profile

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the Profile.
client_token	string	The ClientToken value that was assigned when the Profile was created.
creation_time	string (date-time)	The date and time that the Profile was created, in Unix time format and Coordinated Universal Time (UTC).
id	string	ID of the Profile.
modification_time	string (date-time)	The date and time that the Profile was modified, in Unix time format and Coordinated Universal Time (UTC).
name	string	Name of the Profile. (pattern: <code>^(?!^[0-9]+$)([a-zA-Z0-9-_' ']+)$</code>)
owner_id	string	Amazon Web Services account ID of the Profile owner.
share_status	string	Sharing status for the Profile. (NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME)
status	string	The status for the Profile. (COMPLETE, DELETING, UPDATING, CREATING, DELETED, FAILED)
status_message	string	Status message that includes additiona information about the Profile.

list_profiles

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the Profile.
id	string	ID of the Profile.
name	string	Name of the Profile. (pattern: <code>^(?!^[0-9]+$)([a-zA-Z0-9-_' ']+)$</code>)
share_status	string	Share status of the Profile. (NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_profile	select	profile_id, region		Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile.
list_profiles	select	region	maxResults, nextToken	Lists all the Route 53 Profiles associated with your Amazon Web Services account.
create_profile	insert	region, ClientToken		Creates an empty Route 53 Profile.
associate_profile	update	region, ProfileId, ResourceId		Associates a Route 53 Profiles profile with a VPC. A VPC can have only one Profile associated with it, but a Profile can be associated with 1000 of VPCs (and you can request a higher quota). For more information, see https:​//docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities.
associate_resource_to_profile	update	region, ProfileId, ResourceArn		Associates a DNS reource configuration to a Route 53 Profile.
disassociate_profile	update	profile_id, resource_id, region		Dissociates a specified Route 53 Profile from the specified VPC.
disassociate_resource_from_profile	update	profile_id, resource_arn, region		Dissoaciated a specified resource, from the Route 53 Profile.
delete_profile	delete	profile_id, region		Deletes the specified Route 53 Profile. Before you can delete a profile, you must first disassociate it from all VPCs.

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
profile_id	string	The ID of the Profile that you want to delete.
region	string	AWS region (default: us-east-1)
resource_arn	string	The Amazon Resource Name (ARN) of the resource.
resource_id	string	The ID of the VPC.
maxResults	integer	The maximum number of objects that you want to return for this request. If more objects are available, in the response, a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided. If you don't specify a value for MaxResults, up to 100 objects are returned.
nextToken	string	For the first call to this list request, omit this value. When you request a list of objects, at most the number of objects specified by MaxResults is returned. If more objects are available for retrieval, a NextToken value is returned in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

SELECT examples

get_profile

Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile.

SELECT
arn,
client_token,
creation_time,
id,
modification_time,
name,
owner_id,
share_status,
status,
status_message
FROM aws.route53profiles.profiles
WHERE profile_id = '{{ profile_id }}' -- required
AND region = '{{ region }}' -- required
;

list_profiles

Lists all the Route 53 Profiles associated with your Amazon Web Services account.

SELECT
arn,
id,
name,
share_status
FROM aws.route53profiles.profiles
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_profile

Creates an empty Route 53 Profile.

INSERT INTO aws.route53profiles.profiles (
ClientToken,
Name,
Tags,
region
)
SELECT 
'{{ ClientToken }}' /* required */,
'{{ Name }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
profile
;

Manifest

# Description fields are for documentation purposes
- name: profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the profiles resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: Name
    value: "{{ Name }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

associate_profile

Associates a Route 53 Profiles profile with a VPC. A VPC can have only one Profile associated with it, but a Profile can be associated with 1000 of VPCs (and you can request a higher quota). For more information, see https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities.

UPDATE aws.route53profiles.profiles
SET 
Name = '{{ Name }}',
ProfileId = '{{ ProfileId }}',
ResourceId = '{{ ResourceId }}',
Tags = '{{ Tags }}'
WHERE 
region = '{{ region }}' --required
AND ProfileId = '{{ ProfileId }}' --required
AND ResourceId = '{{ ResourceId }}' --required
RETURNING
profile_association;

associate_resource_to_profile

Associates a DNS reource configuration to a Route 53 Profile.

UPDATE aws.route53profiles.profiles
SET 
Name = '{{ Name }}',
ProfileId = '{{ ProfileId }}',
ResourceArn = '{{ ResourceArn }}',
ResourceProperties = '{{ ResourceProperties }}'
WHERE 
region = '{{ region }}' --required
AND ProfileId = '{{ ProfileId }}' --required
AND ResourceArn = '{{ ResourceArn }}' --required
RETURNING
profile_resource_association;

disassociate_profile

Dissociates a specified Route 53 Profile from the specified VPC.

UPDATE aws.route53profiles.profiles
SET 
-- No updatable properties
WHERE 
profile_id = '{{ profile_id }}' --required
AND resource_id = '{{ resource_id }}' --required
AND region = '{{ region }}' --required
RETURNING
profile_association;

disassociate_resource_from_profile

Dissoaciated a specified resource, from the Route 53 Profile.

UPDATE aws.route53profiles.profiles
SET 
-- No updatable properties
WHERE 
profile_id = '{{ profile_id }}' --required
AND resource_arn = '{{ resource_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
profile_resource_association;

DELETE examples

delete_profile

Deletes the specified Route 53 Profile. Before you can delete a profile, you must first disassociate it from all VPCs.

DELETE FROM aws.route53profiles.profiles
WHERE profile_id = '{{ profile_id }}' --required
AND region = '{{ region }}' --required
;