profile_associations

Creates, updates, deletes or gets a profile_association resource or lists profile_associations in a region

Overview

Name	profile_associations
Type	Resource
Description	Resource Type definition for AWS::Route53Profiles::ProfileAssociation
Id	awscc.route53profiles.profile_associations

Fields

get (all properties)

Name	Datatype	Description
resource_id	string	The resource that you associated the profile with.
profile_id	string	The ID of the profile that you associated with the resource that is specified by ResourceId.
id	string	Primary Identifier for Profile Association
name	string	The name of an association between a Profile and a VPC.
▶tags	array	An array of key-value pairs to apply to this resource.
arn	string	The Amazon Resource Name (ARN) of the profile association.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	Primary Identifier for Profile Association
region	string	AWS region.

For more information, see AWS::Route53Profiles::ProfileAssociation.

Methods

Name	Resource	Accessible by	Required Params
create_resource	profile_associations	INSERT	ResourceId, ProfileId, Name, region
delete_resource	profile_associations	DELETE	Identifier, region
update_resource	profile_associations	UPDATE	Identifier, PatchDocument, region
list_resources	profile_associations_list_only	SELECT	region
get_resource	profile_associations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual profile_association.

SELECT
  region,
  resource_id,
  profile_id,
  id,
  name,
  tags,
  arn
FROM awscc.route53profiles.profile_associations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all profile_associations in a region.

SELECT
  region,
  id
FROM awscc.route53profiles.profile_associations_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new profile_association resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.route53profiles.profile_associations (
  ResourceId,
  ProfileId,
  Name,
  region
)
SELECT
  '{{ resource_id }}',
  '{{ profile_id }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.route53profiles.profile_associations (
  ResourceId,
  ProfileId,
  Name,
  Tags,
  Arn,
  region
)
SELECT
  '{{ resource_id }}',
  '{{ profile_id }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: profile_association
  props:
    - name: resource_id
      value: '{{ resource_id }}'
    - name: profile_id
      value: '{{ profile_id }}'
    - name: name
      value: '{{ name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: arn
      value: '{{ arn }}'

UPDATE example

Use the following StackQL query and manifest file to update a profile_association resource, using stack-deploy.

/*+ update */
UPDATE awscc.route53profiles.profile_associations
SET PatchDocument = string('{{ {
    "Tags": tags,
    "Arn": arn
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.route53profiles.profile_associations
WHERE
  Identifier = '{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the profile_associations resource, the following permissions are required:

Create

route53profiles:AssociateProfile,
route53profiles:GetProfileAssociation,
route53profiles:ListProfileAssociations,
ec2:DescribeVpcs,
route53profiles:TagResource,
route53profiles:ListTagsForResource

Update

route53profiles:GetProfileAssociation,
route53profiles:TagResource,
route53profiles:UntagResource,
route53profiles:ListTagsForResource

Read

route53profiles:GetProfileAssociation,
route53profiles:ListTagsForResource

Delete

route53profiles:DisassociateProfile,
route53profiles:GetProfileAssociation,
route53profiles:UntagResource,
route53profiles:ListTagsForResource

List

route53profiles:ListProfileAssociations,
route53profiles:ListTagsForResource