managed_policies

Creates, updates, deletes or gets a managed_policy resource or lists managed_policies in a region

Overview

Name	managed_policies
Type	Resource
Description	Creates a new managed policy for your AWS-account. This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for managed policies in the IAM User Guide. As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide. For more information about managed policies in general, see Managed policies and inline policies in the IAM User Guide.
Id	awscc.iam.managed_policies

Fields

get (all properties)

Name	Datatype	Description
description	string	A friendly description of the policy. Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables." The policy description is immutable. After a value is assigned, it cannot be changed.
groups	array	The name (friendly name, not ARN) of the group to attach the policy to. 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: _+=,.@-
managed_policy_name	string	The friendly name of the policy. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging Resources in Templates. Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}.
path	string	The path for the policy. For more information about paths, see IAM identifiers in the IAM User Guide. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. You cannot use an asterisk (*) in the path name.
policy_document	object	The JSON policy document that you want to use as the content for the new policy. 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 maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and character quotas. To learn more about JSON policy grammar, see Grammar of the IAM JSON policy language in the IAM User Guide. 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)
roles	array	The name (friendly name, not ARN) of the role to attach the policy to. This parameter allows (per 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: _+=,.@- If an external policy (such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy) has a Ref to a role and if a resource (such as AWS::ECS::Service) also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that CFN deletes the AWS::ECS::Service resource before deleting its role's policy.
users	array	The name (friendly name, not ARN) of the IAM user to attach the policy to. 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: _+=,.@-
policy_arn	string
attachment_count	integer
create_date	string
update_date	string
default_version_id	string
is_attachable	boolean
permissions_boundary_usage_count	integer
policy_id	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
policy_arn	string
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual managed_policy.

SELECT
  region,
  description,
  groups,
  managed_policy_name,
  path,
  policy_document,
  roles,
  users,
  policy_arn,
  attachment_count,
  create_date,
  update_date,
  default_version_id,
  is_attachable,
  permissions_boundary_usage_count,
  policy_id
FROM awscc.iam.managed_policies
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ policy_arn }}';

list (identifiers only)

Lists all managed_policies in a region.

SELECT
  region,
  policy_arn
FROM awscc.iam.managed_policies_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.iam.managed_policies (
  Description,
  Groups,
  ManagedPolicyName,
  Path,
  PolicyDocument,
  Roles,
  Users,
  region
)
SELECT
  '{{ description }}',
  '{{ groups }}',
  '{{ managed_policy_name }}',
  '{{ path }}',
  '{{ policy_document }}',
  '{{ roles }}',
  '{{ users }}',
  '{{ 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: managed_policy
  props:
    - name: description
      value: '{{ description }}'
    - name: groups
      value:
        - '{{ groups[0] }}'
    - name: managed_policy_name
      value: '{{ managed_policy_name }}'
    - name: path
      value: '{{ path }}'
    - name: policy_document
      value: {}
    - name: roles
      value:
        - '{{ roles[0] }}'
    - name: users
      value:
        - '{{ users[0] }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iam.managed_policies
SET PatchDocument = string('{{ {
    "Groups": groups,
    "PolicyDocument": policy_document,
    "Roles": roles,
    "Users": users
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ policy_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

iam:CreatePolicy,
iam:AttachGroupPolicy,
iam:AttachUserPolicy,
iam:AttachRolePolicy

Read

iam:GetPolicy,
iam:ListEntitiesForPolicy,
iam:GetPolicyVersion

Update

iam:DetachRolePolicy,
iam:GetPolicy,
iam:ListPolicyVersions,
iam:DetachGroupPolicy,
iam:DetachUserPolicy,
iam:CreatePolicyVersion,
iam:DeletePolicyVersion,
iam:AttachGroupPolicy,
iam:AttachUserPolicy,
iam:AttachRolePolicy

Delete

iam:DetachRolePolicy,
iam:GetPolicy,
iam:ListPolicyVersions,
iam:DetachGroupPolicy,
iam:DetachUserPolicy,
iam:DeletePolicyVersion,
iam:DeletePolicy,
iam:ListEntitiesForPolicy

List

iam:ListPolicies