Class CfnGroup

A group object, which contains a specified group’s metadata and attributes.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnGroup

Implements

IInspectable

IGroupRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.IdentityStore

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnGroup : CfnResource, IInspectable, IGroupRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnGroup Inherits CfnResource Implements IInspectable, IGroupRef, IConstruct, IDependable, IEnvironmentAware

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(Construct, string, ICfnGroupProps)

Create a new AWS::IdentityStore::Group.

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	A group object, which contains a specified group’s metadata and attributes.
CfnPropertyNames	A group object, which contains a specified group’s metadata and attributes.
Description	A string containing the description of the group.
DisplayName	The display name value for the group.
GroupRef	A reference to a Group resource.
IdentityStoreId	The globally unique identifier for the identity store.

Methods

ArnForGroup(IGroupRef)	A group object, which contains a specified group’s metadata and attributes.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnGroup(object)	Checks whether the given object is a CfnGroup.
RenderProperties(IDictionary<string, object>)	A group object, which contains a specified group’s metadata and attributes.

Constructors

CfnGroup(Construct, string, ICfnGroupProps)

Create a new AWS::IdentityStore::Group.

public CfnGroup(Construct scope, string id, ICfnGroupProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnGroupProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html

CloudformationResource: AWS::IdentityStore::Group

ExampleMetadata: fixture=_generated

Properties

AttrGroupId

The identifier of the newly created group in the identity store.

public virtual string AttrGroupId { get; }

Property Value

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

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html

CloudformationResource: AWS::IdentityStore::Group

ExampleMetadata: fixture=_generated

CfnProperties

A group object, which contains a specified group’s metadata and attributes.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html

CloudformationResource: AWS::IdentityStore::Group

ExampleMetadata: fixture=_generated

CfnPropertyNames

A group object, which contains a specified group’s metadata and attributes.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html

CloudformationResource: AWS::IdentityStore::Group

ExampleMetadata: fixture=_generated

Description

A string containing the description of the group.

public virtual string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html

CloudformationResource: AWS::IdentityStore::Group

ExampleMetadata: fixture=_generated

DisplayName

The display name value for the group.

public virtual string DisplayName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html

CloudformationResource: AWS::IdentityStore::Group

ExampleMetadata: fixture=_generated

GroupRef

A reference to a Group resource.

public virtual IGroupReference GroupRef { get; }

Property Value

IGroupReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html

CloudformationResource: AWS::IdentityStore::Group

ExampleMetadata: fixture=_generated

IdentityStoreId

The globally unique identifier for the identity store.

public virtual string IdentityStoreId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html

CloudformationResource: AWS::IdentityStore::Group

ExampleMetadata: fixture=_generated

Methods

ArnForGroup(IGroupRef)

A group object, which contains a specified group’s metadata and attributes.

public static string ArnForGroup(IGroupRef resource)

Parameters

resource IGroupRef

Returns

string

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"
             });

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.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html

CloudformationResource: AWS::IdentityStore::Group

ExampleMetadata: fixture=_generated

IsCfnGroup(object)

Checks whether the given object is a CfnGroup.

public static bool IsCfnGroup(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html

CloudformationResource: AWS::IdentityStore::Group

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

A group object, which contains a specified group’s metadata and attributes.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html

CloudformationResource: AWS::IdentityStore::Group

ExampleMetadata: fixture=_generated

Implements

IInspectable

IGroupRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware