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	Resource Type definition for AWS::SSM::ResourcePolicy
Id	aws.ssm.resource_policies

Fields

Name	Datatype	Description
resource_arn	string	Arn of OpsItemGroup etc.
policy	object	Actual policy statement.
policy_id	string	An unique identifier within the policies of a resource.
policy_hash	string	A snapshot identifier for the policy over time.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ResourceArn, Policy, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all resource_policies in a region.

SELECT
region,
resource_arn,
policy,
policy_id,
policy_hash
FROM aws.ssm.resource_policies
WHERE region = 'us-east-1';

Gets all properties from an individual resource_policy.

SELECT
region,
resource_arn,
policy,
policy_id,
policy_hash
FROM aws.ssm.resource_policies
WHERE region = 'us-east-1' AND data__Identifier = '<PolicyId>|<ResourceArn>';

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 aws.ssm.resource_policies (
 ResourceArn,
 Policy,
 region
)
SELECT 
'{{ ResourceArn }}',
 '{{ Policy }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ssm.resource_policies (
 ResourceArn,
 Policy,
 region
)
SELECT 
 '{{ ResourceArn }}',
 '{{ Policy }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: resource_policy
    props:
      - name: ResourceArn
        value: '{{ ResourceArn }}'
      - name: Policy
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.ssm.resource_policies
WHERE data__Identifier = '<PolicyId|ResourceArn>'
AND region = 'us-east-1';

Permissions

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

Create

ssm:PutResourcePolicy

Read

ssm:GetResourcePolicies

Update

ssm:PutResourcePolicy

Delete

ssm:DeleteResourcePolicy

List

ssm:GetResourcePolicies