Class CfnGroup
A CloudFormation AWS::IAM::Group
.
Inherited Members
Namespace: Amazon.CDK.AWS.IAM
Assembly: Amazon.CDK.AWS.IAM.dll
Syntax (csharp)
public class CfnGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates a new group.
For information about the number of groups you can create, see Limitations on IAM Entities in the IAM User Guide .
CloudformationResource: AWS::IAM::Group
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html
ExampleMetadata: fixture=_generated
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;
var policyDocument;
var cfnGroup = new CfnGroup(this, "MyCfnGroup", new CfnGroupProps {
GroupName = "groupName",
ManagedPolicyArns = new [] { "managedPolicyArns" },
Path = "path",
Policies = new [] { new PolicyProperty {
PolicyDocument = policyDocument,
PolicyName = "policyName"
} }
});
Synopsis
Constructors
CfnGroup(Construct, String, ICfnGroupProps) | Create a new |
CfnGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | Returns the Amazon Resource Name (ARN) for the specified |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
GroupName | The name of the group to create. Do not include the path in this value. |
ManagedPolicyArns | The Amazon Resource Name (ARN) of the IAM policy you want to attach. |
Path | The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide . |
Policies | Adds or updates an inline policy document that is embedded in the specified IAM group. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnGroup(Construct, String, ICfnGroupProps)
Create a new AWS::IAM::Group
.
public CfnGroup(Construct scope, string id, ICfnGroupProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnGroupProps
- resource properties.
CfnGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
Returns the Amazon Resource Name (ARN) for the specified AWS::IAM::Group
resource.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example: arn:aws:iam::123456789012:group/mystack-mygroup-1DZETITOWEKVO
.
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
GroupName
The name of the group to create. Do not include the path in this value.
public virtual string GroupName { get; set; }
Property Value
System.String
Remarks
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
The Amazon Resource Name (ARN) of the IAM policy you want to attach.
public virtual string[] ManagedPolicyArns { get; set; }
Property Value
System.String[]
Remarks
For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .
Path
The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide .
public virtual string Path { get; set; }
Property Value
System.String
Remarks
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
Adds or updates an inline policy document that is embedded in the specified IAM group.
public virtual object Policies { get; set; }
Property Value
System.Object
Remarks
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 .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>