aws-cdk-lib.aws_iam.GroupProps

GroupProps Struct

Properties for defining an IAM group.

Source

aws-iam/lib/group.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iam as iam } from 'aws-cdk-lib';

declare const managedPolicy: iam.ManagedPolicy;
const groupProps: iam.GroupProps = {
  groupName: 'groupName',
  managedPolicies: [managedPolicy],
  path: 'path',
};

Properties

groupNamestringgroup_namestrgroupNameStringGroupNamestringGroupName*string= Generated by CloudFormation (rec…#

A name for the IAM group.

notes · default

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)

managedPoliciesIManagedPolicy[]managed_policiestyping.List[IManagedPolicy]managedPoliciesList<IManagedPolicy>ManagedPoliciesIManagedPolicy[]ManagedPolicies*[]IManagedPolicy= No managed policies.#

A list of managed policies associated with this role.

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

pathstringpathstrpathStringPathstringPath*string= /#

The path to the group.

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

Used as props by

• Group