Package software.amazon.awscdk.services.iam

Interface CfnManagedPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnManagedPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:18.023Z")
@Stability(Stable)
public interface CfnManagedPolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnManagedPolicy.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iam.*;
 Object policyDocument;
 CfnManagedPolicyProps cfnManagedPolicyProps = CfnManagedPolicyProps.builder()
         .policyDocument(policyDocument)
         // the properties below are optional
         .description("description")
         .groups(List.of("groups"))
         .managedPolicyName("managedPolicyName")
         .path("path")
         .roles(List.of("roles"))
         .users(List.of("users"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnManagedPolicyProps.Builder	A builder for CfnManagedPolicyProps
static final class	CfnManagedPolicyProps.Jsii$Proxy	An implementation for CfnManagedPolicyProps

Method Summary

Modifier and Type	Method	Description
static CfnManagedPolicyProps.Builder	builder()
default String	getDescription()	A friendly description of the policy.
default List<String>	getGroups()	The name (friendly name, not ARN) of the group to attach the policy to.
default String	getManagedPolicyName()	The friendly name of the policy.
default String	getPath()	The path for the policy.
Object	getPolicyDocument()	The JSON policy document that you want to use as the content for the new policy.
default List<String>	getRoles()	The name (friendly name, not ARN) of the role to attach the policy to.
default List<String>	getUsers()	The name (friendly name, not ARN) of the IAM user to attach the policy to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPolicyDocument

@Stability(Stable)
@NotNull
Object getPolicyDocument()

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 AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation 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 AWS STS 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 ( ) through the end of the ASCII character range
• The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ )
• The special characters tab ( ), line feed ( ), and carriage return ( )

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-policydocument

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-description

getGroups

@Stability(Stable)
@Nullable
default List<String> getGroups()

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: _+=,.@-

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-groups

getManagedPolicyName

@Stability(Stable)
@Nullable
default String getManagedPolicyName()

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 IAM Resources in AWS CloudFormation 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"}]]} .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-managedpolicyname

getPath

@Stability(Stable)
@Nullable
default String getPath()

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 ! ( ! ) through the DEL character (  ), including most punctuation characters, digits, and upper and lowercased letters.

You cannot use an asterisk (*) in the path name.

Default: - "/"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-path

getRoles

@Stability(Stable)
@Nullable
default List<String> getRoles()

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 AWS CloudFormation deletes the AWS::ECS::Service resource before deleting its role's policy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-roles

getUsers

@Stability(Stable)
@Nullable
default List<String> getUsers()

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: _+=,.@-

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-users

builder

@Stability(Stable)
static CfnManagedPolicyProps.Builder builder()

Returns:

a CfnManagedPolicyProps.Builder of CfnManagedPolicyProps