policy_statements

Creates, updates, deletes or gets a policy_statement resource or lists policy_statements in a region

Overview

Name	policy_statements
Type	Resource
Description	Policy Statement defined in AWS Entity Resolution Service
Id	awscc.entityresolution.policy_statements

Fields

get (all properties)

Name	Datatype	Description
arn	string	Arn of the resource to which the policy statement is being attached.
statement_id	string	The Statement Id of the policy statement that is being attached.
effect	string
action	array
principal	array
condition	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	Arn of the resource to which the policy statement is being attached.
statement_id	string	The Statement Id of the policy statement that is being attached.
region	string	AWS region.

For more information, see AWS::EntityResolution::PolicyStatement.

Methods

Name	Resource	Accessible by	Required Params
create_resource	policy_statements	INSERT	Arn, StatementId, region
delete_resource	policy_statements	DELETE	Identifier, region
update_resource	policy_statements	UPDATE	Identifier, PatchDocument, region
list_resources	policy_statements_list_only	SELECT	region
get_resource	policy_statements	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual policy_statement.

SELECT
  region,
  arn,
  statement_id,
  effect,
  action,
  principal,
  condition
FROM awscc.entityresolution.policy_statements
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}|{{ statement_id }}';

list (identifiers only)

Lists all policy_statements in a region.

SELECT
  region,
  arn,
  statement_id
FROM awscc.entityresolution.policy_statements_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.entityresolution.policy_statements (
  Arn,
  StatementId,
  region
)
SELECT
  '{{ arn }}',
  '{{ statement_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.entityresolution.policy_statements (
  Arn,
  StatementId,
  Effect,
  Action,
  Principal,
  Condition,
  region
)
SELECT
  '{{ arn }}',
  '{{ statement_id }}',
  '{{ effect }}',
  '{{ action }}',
  '{{ principal }}',
  '{{ condition }}',
  '{{ 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: policy_statement
  props:
    - name: arn
      value: '{{ arn }}'
    - name: statement_id
      value: '{{ statement_id }}'
    - name: effect
      value: '{{ effect }}'
    - name: action
      value:
        - '{{ action[0] }}'
    - name: principal
      value:
        - '{{ principal[0] }}'
    - name: condition
      value: '{{ condition }}'

UPDATE example

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

/*+ update */
UPDATE awscc.entityresolution.policy_statements
SET PatchDocument = string('{{ {
    "Effect": effect,
    "Action": action,
    "Principal": principal,
    "Condition": condition
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}|{{ statement_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

entityresolution:AddPolicyStatement

Read

entityresolution:GetPolicy

Update

entityresolution:AddPolicyStatement,
entityresolution:DeletePolicyStatement

Delete

entityresolution:DeletePolicyStatement,
entityresolution:GetPolicy

List

entityresolution:GetPolicy