software.amazon.awscdk.services.iam

Class CfnManagedPolicy.Builder

java.lang.Object

software.amazon.awscdk.services.iam.CfnManagedPolicy.Builder

Enclosing class:

CfnManagedPolicy

public static final class CfnManagedPolicy.Builder
extends java.lang.Object

A fluent builder for CfnManagedPolicy.

Method Summary

Modifier and Type	Method and Description
CfnManagedPolicy	build()
static CfnManagedPolicy.Builder	create(Construct scope, java.lang.String id)
CfnManagedPolicy.Builder	description(java.lang.String description) A friendly description of the policy.
CfnManagedPolicy.Builder	groups(java.util.List<java.lang.String> groups) The name (friendly name, not ARN) of the group to attach the policy to.
CfnManagedPolicy.Builder	managedPolicyName(java.lang.String managedPolicyName) The friendly name of the policy.
CfnManagedPolicy.Builder	path(java.lang.String path) The path for the policy.
CfnManagedPolicy.Builder	policyDocument(java.lang.Object policyDocument) The JSON policy document that you want to use as the content for the new policy.
CfnManagedPolicy.Builder	roles(java.util.List<java.lang.String> roles) The name (friendly name, not ARN) of the role to attach the policy to.
CfnManagedPolicy.Builder	users(java.util.List<java.lang.String> users) The name (friendly name, not ARN) of the IAM user to attach the policy to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CfnManagedPolicy.Builder create(Construct scope,
                                              java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnManagedPolicy.Builder.

policyDocument

public CfnManagedPolicy.Builder policyDocument(java.lang.Object policyDocument)

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 ( \ 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 )

Parameters:

policyDocument - The JSON policy document that you want to use as the content for the new policy. This parameter is required.

Returns:

this

description

public CfnManagedPolicy.Builder description(java.lang.String description)

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.

Parameters:

description - A friendly description of the policy. This parameter is required.

Returns:

this

groups

public CfnManagedPolicy.Builder groups(java.util.List<java.lang.String> groups)

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

Parameters:

groups - The name (friendly name, not ARN) of the group to attach the policy to. This parameter is required.

Returns:

this

managedPolicyName

public CfnManagedPolicy.Builder managedPolicyName(java.lang.String managedPolicyName)

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"}]]} .

Parameters:

managedPolicyName - The friendly name of the policy. This parameter is required.

Returns:

this

path

public CfnManagedPolicy.Builder path(java.lang.String path)

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.

Parameters:

path - The path for the policy. This parameter is required.

Returns:

this

roles

public CfnManagedPolicy.Builder roles(java.util.List<java.lang.String> roles)

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.

Parameters:

roles - The name (friendly name, not ARN) of the role to attach the policy to. This parameter is required.

Returns:

this

users

public CfnManagedPolicy.Builder users(java.util.List<java.lang.String> users)

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

Parameters:

users - The name (friendly name, not ARN) of the IAM user to attach the policy to. This parameter is required.

Returns:

this

build

public CfnManagedPolicy build()