GroupProps

class aws_cdk.aws_iam.GroupProps(*, group_name=None, managed_policies=None, path=None)

Bases: object

Properties for defining an IAM group.

Parameters:

  • group_name (Optional[str]) – 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)

  • managed_policies (Optional[Sequence[IManagedPolicy]]) – A list of managed policies associated with this role. You can add managed policies later using addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName)). Default: - No managed policies.

  • path (Optional[str]) – The path to the group. For more information about paths, see IAM Identifiers in the IAM User Guide. Default: /

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iam as iam

# managed_policy: iam.ManagedPolicy

group_props = iam.GroupProps(
    group_name="groupName",
    managed_policies=[managed_policy],
    path="path"
)

Attributes

group_name

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)

managed_policies

A list of managed policies associated with this role.

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

Default:

  • No managed policies.

path

The path to the group.

For more information about paths, see IAM Identifiers in the IAM User Guide.

Default:

/