1.204.0

interface CfnGroupProps

LanguageType name
.NETAmazon.CDK.AWS.IAM.CfnGroupProps
Javasoftware.amazon.awscdk.services.iam.CfnGroupProps
Pythonaws_cdk.aws_iam.CfnGroupProps
TypeScript @aws-cdk/aws-iam » CfnGroupProps

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 * as iam from '@aws-cdk/aws-iam';

declare const policyDocument: any;
const cfnGroupProps: iam.CfnGroupProps = {
  groupName: 'groupName',
  managedPolicyArns: ['managedPolicyArns'],
  path: 'path',
  policies: [{
    policyDocument: policyDocument,
    policyName: 'policyName',
  }],
};

Properties

NameTypeDescription
groupName?stringThe name of the group to create. Do not include the path in this value.
managedPolicyArns?string[]The Amazon Resource Name (ARN) of the IAM policy you want to attach.
path?stringThe path to the group. For more information about paths, see IAM identifiers in the IAM User Guide .
policies?IResolvable | IResolvable | PolicyProperty[]Adds or updates an inline policy document that is embedded in the specified IAM group.

groupName?

Type: string (optional)

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

managedPolicyArns?

Type: string[] (optional)

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 .

path?

Type: string (optional)

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 ! ( \ u0021 ) through the DEL character ( \ u007F ), including most punctuation characters, digits, and upper and lowercased letters.

policies?

Type: IResolvable | IResolvable | PolicyProperty[] (optional)

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 .

← PreviousNext →