aws-cdk-lib.aws_iam.GroupProps

interface GroupProps

LanguageType name
.NETAmazon.CDK.AWS.IAM.GroupProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiam#GroupProps
Javasoftware.amazon.awscdk.services.iam.GroupProps
Pythonaws_cdk.aws_iam.GroupProps
TypeScript (source)aws-cdk-lib » aws_iam » GroupProps

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 { aws_iam as iam } from 'aws-cdk-lib';

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

Properties

NameTypeDescription
groupName?stringA name for the IAM group.
managedPolicies?IManagedPolicy[]A list of managed policies associated with this role.
path?stringThe path to the group.

groupName?

Type: string (optional, default: Generated by CloudFormation (recommended))

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.


managedPolicies?

Type: IManagedPolicy[] (optional, default: No managed policies.)

A list of managed policies associated with this role.

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


path?

Type: string (optional, default: /)

The path to the group.

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