Policy
The AWS::IAM::Policy resource associates an [inline](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#inline) IAM policy with IAM users, roles, or groups. For more information about IAM policies, see [Overview of IAM Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html) in the IAM User Guide guide.
Import
import { Policy } from 'aws-cdk-lib/aws-iam';Or use the module namespace:
import * as iam from 'aws-cdk-lib/aws-iam';
// iam.PolicyProperties
Configuration passed to the constructor as PolicyProps.
documentOptionalPolicyDocumentInitial PolicyDocument to use for this Policy. If omited, any `PolicyStatement` provided in the `statements` property will be applied against the empty default `PolicyDocument`.
Default: - An empty policy.
forceOptionalbooleanForce creation of an `AWS::IAM::Policy`. Unless set to `true`, this `Policy` construct will not materialize to an `AWS::IAM::Policy` CloudFormation resource in case it would have no effect (for example, if it remains unattached to an IAM identity or if it has no statements). This is generally desired behavior, since it prevents creating invalid--and hence undeployable--CloudFormation templates. In cases where you know the policy must be created and it is actually an error if no statements have been added to it or it remains unattached to an IAM identity, you can set this to `true`.
Default: false
groupsOptionalIGroup[]Groups to attach this policy to. You can also use `attachToGroup(group)` to attach this policy to a group.
Default: - No groups.
policyNameOptionalstringThe name of the policy. If you specify multiple policies for an entity, specify unique names. For example, if you specify a list of policies for an IAM role, each policy must have a unique name.
Default: - Uses the logical ID of the policy resource, which is ensured
to be unique within the stack.
rolesOptionalIRole[]Roles to attach this policy to. You can also use `attachToRole(role)` to attach this policy to a role.
Default: - No roles.
statementsOptionalPolicyStatement[]Initial set of permissions to add to this policy document. You can also use `addStatements(...statement)` to add permissions later.
Default: - No statements.
usersOptionalIUser[]Users to attach this policy to. You can also use `attachToUser(user)` to attach this policy to a user.
Default: - No users.
Get the AWS IAM Cheat Sheet
Everything you need to know about AWS IAM on one page. HD quality, print-friendly.
Download Free InfographicQuick Facts
aws-iam