resource_policies

Creates, updates, deletes or gets a resource_policy resource or lists resource_policies in a region

Overview

Name	resource_policies
Type	Resource
Description	This schema provides construct and validation rules for AWS-XRay Resource Policy resource parameters.
Id	awscc.xray.resource_policies

Fields

get (all properties)

Name	Datatype	Description
policy_name	string	The name of the resource policy. Must be unique within a specific AWS account.
policy_document	string	The resource policy document, which can be up to 5kb in size.
bypass_policy_lockout_check	boolean	A flag to indicate whether to bypass the resource policy lockout safety check
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
policy_name	string	The name of the resource policy. Must be unique within a specific AWS account.
region	string	AWS region.

For more information, see AWS::XRay::ResourcePolicy.

Methods

Name	Resource	Accessible by	Required Params
create_resource	resource_policies	INSERT	PolicyName, PolicyDocument, region
delete_resource	resource_policies	DELETE	Identifier, region
update_resource	resource_policies	UPDATE	Identifier, PatchDocument, region
list_resources	resource_policies_list_only	SELECT	region
get_resource	resource_policies	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual resource_policy.

SELECT
  region,
  policy_name,
  policy_document,
  bypass_policy_lockout_check
FROM awscc.xray.resource_policies
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ policy_name }}';

list (identifiers only)

Lists all resource_policies in a region.

SELECT
  region,
  policy_name
FROM awscc.xray.resource_policies_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.xray.resource_policies (
  PolicyName,
  PolicyDocument,
  region
)
SELECT
  '{{ policy_name }}',
  '{{ policy_document }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.xray.resource_policies (
  PolicyName,
  PolicyDocument,
  BypassPolicyLockoutCheck,
  region
)
SELECT
  '{{ policy_name }}',
  '{{ policy_document }}',
  '{{ bypass_policy_lockout_check }}',
  '{{ 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: resource_policy
  props:
    - name: policy_name
      value: '{{ policy_name }}'
    - name: policy_document
      value: '{{ policy_document }}'
    - name: bypass_policy_lockout_check
      value: '{{ bypass_policy_lockout_check }}'

UPDATE example

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

/*+ update */
UPDATE awscc.xray.resource_policies
SET PatchDocument = string('{{ {
    "PolicyDocument": policy_document,
    "BypassPolicyLockoutCheck": bypass_policy_lockout_check
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ policy_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.xray.resource_policies
WHERE
  Identifier = '{{ policy_name }}' 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 resource_policies resource, the following permissions are required:

Create

xray:PutResourcePolicy,
xray:ListResourcePolicies

Read

xray:ListResourcePolicies

Update

xray:PutResourcePolicy,
xray:ListResourcePolicies

Delete

xray:DeleteResourcePolicy

List

xray:ListResourcePolicies