ManagedPolicy
- class aws_cdk.aws_iam.ManagedPolicy(scope, id, *, description=None, document=None, groups=None, managed_policy_name=None, path=None, roles=None, statements=None, users=None)
Bases:
Resource
Managed policy.
- ExampleMetadata
infused
Example:
my_role = iam.Role(self, "My Role", assumed_by=iam.ServicePrincipal("sns.amazonaws.com") ) fn = lambda_.Function(self, "MyFunction", runtime=lambda_.Runtime.NODEJS_16_X, handler="index.handler", code=lambda_.Code.from_asset(path.join(__dirname, "lambda-handler")), role=my_role ) my_role.add_managed_policy(iam.ManagedPolicy.from_aws_managed_policy_name("service-role/AWSLambdaBasicExecutionRole")) my_role.add_managed_policy(iam.ManagedPolicy.from_aws_managed_policy_name("service-role/AWSLambdaVPCAccessExecutionRole"))
- Parameters
scope (
Construct
) –id (
str
) –description (
Optional
[str
]) – A description of the managed 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. Default: - emptydocument (
Optional
[PolicyDocument
]) – Initial PolicyDocument to use for this ManagedPolicy. If omited, anyPolicyStatement
provided in thestatements
property will be applied against the empty defaultPolicyDocument
. Default: - An empty policy.groups (
Optional
[Sequence
[IGroup
]]) – Groups to attach this policy to. You can also useattachToGroup(group)
to attach this policy to a group. Default: - No groups.managed_policy_name (
Optional
[str
]) – The name of the managed 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: - A name is automatically generated.path (
Optional
[str
]) – The path for the policy. 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. For more information about paths, see IAM Identifiers in the IAM User Guide. Default: - “/”roles (
Optional
[Sequence
[IRole
]]) – Roles to attach this policy to. You can also useattachToRole(role)
to attach this policy to a role. Default: - No roles.statements (
Optional
[Sequence
[PolicyStatement
]]) – Initial set of permissions to add to this policy document. You can also useaddPermission(statement)
to add permissions later. Default: - No statements.users (
Optional
[Sequence
[IUser
]]) – Users to attach this policy to. You can also useattachToUser(user)
to attach this policy to a user. Default: - No users.
Methods
- add_statements(*statement)
Adds a statement to the policy document.
- Parameters
statement (
PolicyStatement
) –- Return type
None
- apply_removal_policy(policy)
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
RemovalPolicy
) –- Return type
None
- attach_to_group(group)
Attaches this policy to a group.
- Parameters
group (
IGroup
) –- Return type
None
- to_string()
Returns a string representation of this construct.
- Return type
str
Attributes
- description
The description of this policy.
- Attribute
true
- document
The policy document.
- env
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- managed_policy_arn
Returns the ARN of this managed policy.
- Attribute
true
- managed_policy_name
The name of this policy.
- Attribute
true
- node
The construct tree node associated with this construct.
- path
The path of this policy.
- Attribute
true
- stack
The stack in which this resource is defined.
Static Methods
- classmethod from_aws_managed_policy_name(managed_policy_name)
Import a managed policy from one of the policies that AWS manages.
For this managed policy, you only need to know the name to be able to use it.
Some managed policy names start with “service-role/”, some start with “job-function/”, and some don’t start with anything. Include the prefix when constructing this object.
- Parameters
managed_policy_name (
str
) –- Return type
- classmethod from_managed_policy_arn(scope, id, managed_policy_arn)
Import an external managed policy by ARN.
For this managed policy, you only need to know the ARN to be able to use it. This can be useful if you got the ARN from a CloudFormation Export.
If the imported Managed Policy ARN is a Token (such as a
CfnParameter.valueAsString
or aFn.importValue()
) and the referenced managed policy has apath
(likearn:...:policy/AdminPolicy/AdminAllow
), themanagedPolicyName
property will not resolve to the correct value. Instead it will resolve to the first path component. We unfortunately cannot express the correct calculation of the full path name as a CloudFormation expression. In this scenario the Managed Policy ARN should be supplied without thepath
in order to resolve the correct managed policy resource.- Parameters
scope (
Construct
) – construct scope.id (
str
) – construct id.managed_policy_arn (
str
) – the ARN of the managed policy to import.
- Return type
- classmethod from_managed_policy_name(scope, id, managed_policy_name)
Import a customer managed policy from the managedPolicyName.
For this managed policy, you only need to know the name to be able to use it.
- Parameters
scope (
Construct
) –id (
str
) –managed_policy_name (
str
) –
- Return type
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
- classmethod is_resource(construct)
Check whether the given construct is a Resource.
- Parameters
construct (
IConstruct
) –- Return type
bool