software.amazon.awscdk.services.iam

Class CfnGroupProps.Builder

java.lang.Object

software.amazon.awscdk.services.iam.CfnGroupProps.Builder

Enclosing interface:

CfnGroupProps

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

A builder for CfnGroupProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnGroupProps	build() Builds the configured instance.
CfnGroupProps.Builder	groupName(java.lang.String groupName) Sets the value of CfnGroupProps.getGroupName()
CfnGroupProps.Builder	managedPolicyArns(java.util.List<java.lang.String> managedPolicyArns) Sets the value of CfnGroupProps.getManagedPolicyArns()
CfnGroupProps.Builder	path(java.lang.String path) Sets the value of CfnGroupProps.getPath()
CfnGroupProps.Builder	policies(IResolvable policies) Sets the value of CfnGroupProps.getPolicies()
CfnGroupProps.Builder	policies(java.util.List<? extends java.lang.Object> policies) Sets the value of CfnGroupProps.getPolicies()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

groupName

public CfnGroupProps.Builder groupName(java.lang.String groupName)

Sets the value of CfnGroupProps.getGroupName()

Parameters:

groupName - The name of the group to create. Do not include the path in this value. The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the group name.

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

Returns:

this

managedPolicyArns

public CfnGroupProps.Builder managedPolicyArns(java.util.List<java.lang.String> managedPolicyArns)

Sets the value of CfnGroupProps.getManagedPolicyArns()

Parameters:

managedPolicyArns - The Amazon Resource Name (ARN) of the IAM policy you want to attach. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .

Returns:

this

path

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

Sets the value of CfnGroupProps.getPath()

Parameters:

path - The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) 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.

Returns:

this

policies

public CfnGroupProps.Builder policies(IResolvable policies)

Sets the value of CfnGroupProps.getPolicies()

Parameters:

policies - Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see Declaring an IAM Group Resource .

The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.

For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the IAM User Guide .

Returns:

this

policies

public CfnGroupProps.Builder policies(java.util.List<? extends java.lang.Object> policies)

Sets the value of CfnGroupProps.getPolicies()

Parameters:

policies - Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see Declaring an IAM Group Resource .

The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.

For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the IAM User Guide .

Returns:

this

build

public CfnGroupProps build()

Builds the configured instance.

Returns:

a new instance of CfnGroupProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided