profile_resource_associations

Creates, updates, deletes or gets a profile_resource_association resource or lists profile_resource_associations in a region

Overview

Name	profile_resource_associations
Type	Resource
Description	Resource Type definition for AWS::Route53Profiles::ProfileResourceAssociation
Id	awscc.route53profiles.profile_resource_associations

Fields

get (all properties)

Name	Datatype	Description
profile_id	string	The ID of the profile that you associated the resource to that is specified by ResourceArn.
id	string	Primary Identifier for Profile Resource Association
name	string	The name of an association between the Profile and resource.
resource_arn	string	The arn of the resource that you associated to the Profile.
resource_properties	string	A JSON-formatted string with key-value pairs specifying the properties of the associated resource.
resource_type	string	The type of the resource associated to the Profile.
region	string	AWS region.

list (identifiers only)

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

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	profile_resource_associations	INSERT	ProfileId, Name, ResourceArn, region
delete_resource	profile_resource_associations	DELETE	Identifier, region
update_resource	profile_resource_associations	UPDATE	Identifier, PatchDocument, region
list_resources	profile_resource_associations_list_only	SELECT	region
get_resource	profile_resource_associations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual profile_resource_association.

SELECT
  region,
  profile_id,
  id,
  name,
  resource_arn,
  resource_properties,
  resource_type
FROM awscc.route53profiles.profile_resource_associations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all profile_resource_associations in a region.

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

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.route53profiles.profile_resource_associations (
  ProfileId,
  Name,
  ResourceArn,
  ResourceProperties,
  region
)
SELECT
  '{{ profile_id }}',
  '{{ name }}',
  '{{ resource_arn }}',
  '{{ resource_properties }}',
  '{{ 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_resource_association
  props:
    - name: profile_id
      value: '{{ profile_id }}'
    - name: name
      value: '{{ name }}'
    - name: resource_arn
      value: '{{ resource_arn }}'
    - name: resource_properties
      value: '{{ resource_properties }}'

UPDATE example

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

/*+ update */
UPDATE awscc.route53profiles.profile_resource_associations
SET PatchDocument = string('{{ {
    "ResourceProperties": resource_properties
} | 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_resource_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_resource_associations resource, the following permissions are required:

Create

route53profiles:AssociateResourceToProfile,
route53profiles:GetProfileResourceAssociation,
route53resolver:GetFirewallRuleGroup,
route53resolver:GetResolverRule,
route53:GetHostedZone,
route53resolver:GetResolverQueryLogConfig,
ec2:DescribeVpcEndpoints

Read

route53profiles:GetProfileResourceAssociation

Delete

route53profiles:DisassociateResourceFromProfile,
route53profiles:GetProfileResourceAssociation,
route53resolver:GetFirewallRuleGroup,
route53resolver:GetResolverRule,
route53:GetHostedZone,
route53resolver:GetResolverQueryLogConfig,
ec2:DescribeVpcEndpoints

List

route53profiles:ListProfileResourceAssociations

Update

route53profiles:UpdateProfileResourceAssociation