Package software.amazon.awscdk.services.iam

Interface CfnGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-17T05:10:12.004Z")
@Stability(Stable)
public interface CfnGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGroup.

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;
 CfnGroupProps cfnGroupProps = CfnGroupProps.builder()
         .groupName("groupName")
         .managedPolicyArns(List.of("managedPolicyArns"))
         .path("path")
         .policies(List.of(PolicyProperty.builder()
                 .policyDocument(policyDocument)
                 .policyName("policyName")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnGroupProps.Builder	builder()
default String	getGroupName()	The name of the group to create.
default List<String>	getManagedPolicyArns()	The Amazon Resource Name (ARN) of the IAM policy you want to attach.
default String	getPath()	The path to the group.
default Object	getPolicies()	Adds or updates an inline policy document that is embedded in the specified IAM group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGroupName

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

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

See Also:

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

getManagedPolicyArns

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

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 .

See Also:

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

getPath

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

The path to the group. 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.

See Also:

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

getPolicies

@Stability(Stable)
@Nullable
default Object getPolicies()

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 .

See Also:

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

builder

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

Returns:

a CfnGroupProps.Builder of CfnGroupProps