profile_associations

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

Overview

Name	profile_associations
Type	Resource
Id	aws.route53profiles.profile_associations

Fields

The following fields are returned by SELECT queries:

get_profile_association

Name	Datatype	Description
creation_time	string (date-time)	The date and time that the Profile association was created, in Unix time format and Coordinated Universal Time (UTC).
id	string	ID of the Profile association.
modification_time	string (date-time)	The date and time that the Profile association was modified, in Unix time format and Coordinated Universal Time (UTC).
name	string	Name of the Profile association. (pattern: <code>^(?!^[0-9]+$)([a-zA-Z0-9-_' ']+)$</code>)
owner_id	string	Amazon Web Services account ID of the Profile association owner.
profile_id	string	ID of the Profile.
resource_id	string	The Amazon Resource Name (ARN) of the VPC.
status	string	Status of the Profile association. (COMPLETE, DELETING, UPDATING, CREATING, DELETED, FAILED)
status_message	string	Additional information about the Profile association.

list_profile_associations

Name	Datatype	Description
creation_time	string (date-time)	The date and time that the Profile association was created, in Unix time format and Coordinated Universal Time (UTC).
id	string	ID of the Profile association.
modification_time	string (date-time)	The date and time that the Profile association was modified, in Unix time format and Coordinated Universal Time (UTC).
name	string	Name of the Profile association. (pattern: <code>^(?!^[0-9]+$)([a-zA-Z0-9-_' ']+)$</code>)
owner_id	string	Amazon Web Services account ID of the Profile association owner.
profile_id	string	ID of the Profile.
resource_id	string	The Amazon Resource Name (ARN) of the VPC.
status	string	Status of the Profile association. (COMPLETE, DELETING, UPDATING, CREATING, DELETED, FAILED)
status_message	string	Additional information about the Profile association.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_profile_association	select	profile_association_id, region		Retrieves a Route 53 Profile association for a VPC. A VPC can have only one Profile association, but a Profile can be associated with up to 5000 VPCs.
list_profile_associations	select	region	maxResults, nextToken, profileId, resourceId	Lists all the VPCs that the specified Route 53 Profile is associated with.

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_association_id	string	The identifier of the association you want to get information about.
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.
profileId	string	ID of the Profile.
resourceId	string	ID of the VPC.

SELECT examples

get_profile_association

Retrieves a Route 53 Profile association for a VPC. A VPC can have only one Profile association, but a Profile can be associated with up to 5000 VPCs.

SELECT
creation_time,
id,
modification_time,
name,
owner_id,
profile_id,
resource_id,
status,
status_message
FROM aws.route53profiles.profile_associations
WHERE profile_association_id = '{{ profile_association_id }}' -- required
AND region = '{{ region }}' -- required
;

list_profile_associations

Lists all the VPCs that the specified Route 53 Profile is associated with.

SELECT
creation_time,
id,
modification_time,
name,
owner_id,
profile_id,
resource_id,
status,
status_message
FROM aws.route53profiles.profile_associations
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND profileId = '{{ profileId }}'
AND resourceId = '{{ resourceId }}'
;