Class CfnGroup
A group object, which contains a specified group’s metadata and attributes.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.IdentityStore
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnGroup : CfnResource, IInspectable
Syntax (vb)
Public Class CfnGroup
Inherits CfnResource
Implements IInspectable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html
CloudformationResource: AWS::IdentityStore::Group
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.IdentityStore;
var cfnGroup = new CfnGroup(this, "MyCfnGroup", new CfnGroupProps {
DisplayName = "displayName",
IdentityStoreId = "identityStoreId",
// the properties below are optional
Description = "description"
});
Synopsis
Constructors
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 |
CfnGroup(Construct, String, ICfnGroupProps) |
Properties
AttrGroupId | The identifier of the newly created group in the identity store. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A string containing the description of the group. |
DisplayName | A string containing the name of the group. |
IdentityStoreId | The globally unique identifier for the identity store. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
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
CfnGroup(Construct, String, ICfnGroupProps)
public CfnGroup(Construct scope, string id, ICfnGroupProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnGroupProps
Resource properties.
Properties
AttrGroupId
The identifier of the newly created group in the identity store.
public virtual string AttrGroupId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: GroupId
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
Description
A string containing the description of the group.
public virtual string Description { get; set; }
Property Value
System.String
DisplayName
A string containing the name of the group.
public virtual string DisplayName { get; set; }
Property Value
System.String
IdentityStoreId
The globally unique identifier for the identity store.
public virtual string IdentityStoreId { get; set; }
Property Value
System.String
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>