group_policies

Creates, updates, deletes or gets a group_policy resource or lists group_policies in a region

Overview

Name	group_policies
Type	Resource
Description	Adds or updates an inline policy document that is embedded in the specified IAM group. A group can also have managed policies attached to it. To attach a managed policy to a group, use AWS::IAM::Group. To create a new managed policy, use AWS::IAM::ManagedPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide. For information about the maximum number of inline policies that you can embed in a group, see IAM and quotas in the IAM User Guide.
Id	awscc.iam.group_policies

Fields

Name	Datatype	Description
policy_document	object	The policy document. You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. The regex pattern used to validate this parameter is a string of characters consisting of the following: + Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range + The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) + The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
policy_name	string	The name of the policy document. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
group_name	string	The name of the group to associate the policy with. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.
region	string	AWS region.

For more information, see AWS::IAM::GroupPolicy.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	PolicyName, GroupName, region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual group_policy.

SELECT
  region,
  policy_document,
  policy_name,
  group_name
FROM awscc.iam.group_policies
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ policy_name }}|{{ group_name }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.iam.group_policies (
  PolicyName,
  GroupName,
  region
)
SELECT
  '{{ policy_name }}',
  '{{ group_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.iam.group_policies (
  PolicyDocument,
  PolicyName,
  GroupName,
  region
)
SELECT
  '{{ policy_document }}',
  '{{ policy_name }}',
  '{{ group_name }}',
  '{{ 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: group_policy
  props:
    - name: policy_document
      value: {}
    - name: policy_name
      value: '{{ policy_name }}'
    - name: group_name
      value: '{{ group_name }}'

UPDATE example

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

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

DELETE example

/*+ delete */
DELETE FROM awscc.iam.group_policies
WHERE
  Identifier = '{{ policy_name }}|{{ group_name }}' AND
  region = 'us-east-1'
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 group_policies resource, the following permissions are required:

Create

iam:PutGroupPolicy,
iam:GetGroupPolicy

Read

iam:GetGroupPolicy

Update

iam:PutGroupPolicy,
iam:GetGroupPolicy

Delete

iam:DeleteGroupPolicy,
iam:GetGroupPolicy