Class GroupProps

Namespace

Amazon.CDK.AWS.IAM

Assembly

Amazon.CDK.AWS.IAM.dll

Properties for defining an IAM group.

public class GroupProps : IGroupProps

Inheritance

object

GroupProps

Implements

IGroupProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.IAM;

            ManagedPolicy managedPolicy;

            var groupProps = new GroupProps {
                GroupName = "groupName",
                ManagedPolicies = new [] { managedPolicy },
                Path = "path"
            };

Remarks

ExampleMetadata: fixture=_generated

Constructors

GroupProps()

public GroupProps()

Properties

GroupName

A name for the IAM group.

public string? GroupName { get; set; }

Property Value

string

Remarks

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)

ManagedPolicies

A list of managed policies associated with this role.

public IManagedPolicy[]? ManagedPolicies { get; set; }

Property Value

IManagedPolicy[]

Remarks

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

Default: - No managed policies.

Path

The path to the group.

public string? Path { get; set; }

Property Value

string

Remarks

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

Default: /