profile_resource_associations

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

Overview

Name	profile_resource_associations
Type	Resource
Id	aws.route53profiles.profile_resource_associations

Fields

The following fields are returned by SELECT queries:

get_profile_resource_association

Name	Datatype	Description
creation_time	string (date-time)	The date and time that the Profile resource association was created, in Unix time format and Coordinated Universal Time (UTC).
id	string	ID of the Profile resource association.
modification_time	string (date-time)	The date and time that the Profile resource association was modified, in Unix time format and Coordinated Universal Time (UTC).
name	string	Name of the Profile resource association. (pattern: <code>^(?!^[0-9]+$)([a-zA-Z0-9-_' ']+)$</code>)
owner_id	string	Amazon Web Services account ID of the Profile resource association owner.
profile_id	string	Profile ID of the Profile that the resources are associated with.
resource_arn	string	The Amazon Resource Name (ARN) of the resource association.
resource_properties	string	If the DNS resource is a DNS Firewall rule group, this indicates the priority.
resource_type	string	Resource type, such as a private hosted zone, or DNS Firewall rule group.
status	string	Status of the Profile resource association. (COMPLETE, DELETING, UPDATING, CREATING, DELETED, FAILED)
status_message	string	Additional information about the Profile resource association.

list_profile_resource_associations

Name	Datatype	Description
creation_time	string (date-time)	The date and time that the Profile resource association was created, in Unix time format and Coordinated Universal Time (UTC).
id	string	ID of the Profile resource association.
modification_time	string (date-time)	The date and time that the Profile resource association was modified, in Unix time format and Coordinated Universal Time (UTC).
name	string	Name of the Profile resource association. (pattern: <code>^(?!^[0-9]+$)([a-zA-Z0-9-_' ']+)$</code>)
owner_id	string	Amazon Web Services account ID of the Profile resource association owner.
profile_id	string	Profile ID of the Profile that the resources are associated with.
resource_arn	string	The Amazon Resource Name (ARN) of the resource association.
resource_properties	string	If the DNS resource is a DNS Firewall rule group, this indicates the priority.
resource_type	string	Resource type, such as a private hosted zone, or DNS Firewall rule group.
status	string	Status of the Profile resource association. (COMPLETE, DELETING, UPDATING, CREATING, DELETED, FAILED)
status_message	string	Additional information about the Profile resource association.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_profile_resource_association	select	profile_resource_association_id, region		Returns information about a specified Route 53 Profile resource association.
list_profile_resource_associations	select	profile_id, region	maxResults, nextToken, resourceType	Lists all the resource associations for the specified Route 53 Profile.
update_profile_resource_association	update	profile_resource_association_id, region		Updates the specified Route 53 Profile resourse association.

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.
profile_resource_association_id	string	ID of the resource association.
region	string	AWS region (default: us-east-1)
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.
resourceType	string	ID of a resource if you want information on only one type.

SELECT examples

get_profile_resource_association

Returns information about a specified Route 53 Profile resource association.

SELECT
creation_time,
id,
modification_time,
name,
owner_id,
profile_id,
resource_arn,
resource_properties,
resource_type,
status,
status_message
FROM aws.route53profiles.profile_resource_associations
WHERE profile_resource_association_id = '{{ profile_resource_association_id }}' -- required
AND region = '{{ region }}' -- required
;

list_profile_resource_associations

Lists all the resource associations for the specified Route 53 Profile.

SELECT
creation_time,
id,
modification_time,
name,
owner_id,
profile_id,
resource_arn,
resource_properties,
resource_type,
status,
status_message
FROM aws.route53profiles.profile_resource_associations
WHERE profile_id = '{{ profile_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND resourceType = '{{ resourceType }}'
;

UPDATE examples

update_profile_resource_association

Updates the specified Route 53 Profile resourse association.

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