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 | awscc.ssm.resource_policies |
Fields
- get (all properties)
- list (identifiers only)
| 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. |
| 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. |
region | string | AWS region. |
For more information, see AWS::SSM::ResourcePolicy.
Methods
| Name | Resource | Accessible by | Required Params |
|---|---|---|---|
create_resource | resource_policies | INSERT | ResourceArn, Policy, 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)
- list (identifiers only)
Gets all properties from an individual resource_policy.
SELECT
region,
resource_arn,
policy,
policy_id,
policy_hash
FROM awscc.ssm.resource_policies
WHERE
region = 'us-east-1' AND
Identifier = '{{ policy_id }}|{{ resource_arn }}';
Lists all resource_policies in a region.
SELECT
region,
policy_id,
resource_arn
FROM awscc.ssm.resource_policies_list_only
WHERE
region = 'us-east-1';
INSERT example
Use the following StackQL query and manifest file to create a new resource_policy resource, using stack-deploy.
- Required Properties
- All Properties
- Manifest
/*+ create */
INSERT INTO awscc.ssm.resource_policies (
ResourceArn,
Policy,
region
)
SELECT
'{{ resource_arn }}',
'{{ policy }}',
'{{ region }}';
/*+ create */
INSERT INTO awscc.ssm.resource_policies (
ResourceArn,
Policy,
region
)
SELECT
'{{ resource_arn }}',
'{{ policy }}',
'{{ region }}';
version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
value: '{{ vars.AWS_REGION }}'
resources:
- name: resource_policy
props:
- name: resource_arn
value: '{{ resource_arn }}'
- name: policy
value: {}
UPDATE example
Use the following StackQL query and manifest file to update a resource_policy resource, using stack-deploy.
/*+ update */
UPDATE awscc.ssm.resource_policies
SET PatchDocument = string('{{ {
"Policy": policy
} | generate_patch_document }}')
WHERE
region = '{{ region }}' AND
Identifier = '{{ policy_id }}|{{ resource_arn }}';
DELETE example
/*+ delete */
DELETE FROM awscc.ssm.resource_policies
WHERE
Identifier = '{{ policy_id }}|{{ resource_arn }}' AND
region = 'us-east-1';
Permissions
To operate on the resource_policies resource, the following permissions are required:
- Create
- Read
- Update
- Delete
- List
ssm:PutResourcePolicy
ssm:GetResourcePolicies
ssm:GetResourcePolicies,
ssm:PutResourcePolicy
ssm:GetResourcePolicies,
ssm:DeleteResourcePolicy
ssm:GetResourcePolicies