Package software.amazon.awscdk.services.iam

Interface GroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:02.780Z")
@Stability(Stable)
public interface GroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining an IAM group.

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.*;
 ManagedPolicy managedPolicy;
 GroupProps groupProps = GroupProps.builder()
         .groupName("groupName")
         .managedPolicies(List.of(managedPolicy))
         .path("path")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GroupProps.Builder	builder()
default String	getGroupName()	A name for the IAM group.
default List<IManagedPolicy>	getManagedPolicies()	A list of managed policies associated with this role.
default String	getPath()	The path to the group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGroupName

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

A name for the IAM group.

For valid values, see the GroupName parameter for the CreateGroup action in the IAM API Reference. 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 must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

Default: Generated by CloudFormation (recommended)

getManagedPolicies

@Stability(Stable)
@Nullable
default List<IManagedPolicy> getManagedPolicies()

A list of managed policies associated with this role.

You can add managed policies later using addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName)).

Default: - No managed policies.

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.

Default: /

builder

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

Returns:

a GroupProps.Builder of GroupProps