software.amazon.awscdk.services.identitystore

Class CfnGroup

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.identitystore.CfnGroup

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:22.297Z")
public class CfnGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IdentityStore::Group`.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.identitystore.*;
 CfnGroup cfnGroup = CfnGroup.Builder.create(this, "MyCfnGroup")
         .displayName("displayName")
         .identityStoreId("identityStoreId")
         // the properties below are optional
         .description("description")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnGroup.Builder A fluent builder for CfnGroup.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnGroup(Construct scope, java.lang.String id, CfnGroupProps props) Create a new `AWS::IdentityStore::Group`.
protected	CfnGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrGroupId() The identifier of the newly created group in the identity store.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A string containing the description of the group.
java.lang.String	getDisplayName() `AWS::IdentityStore::Group.DisplayName`.
java.lang.String	getIdentityStoreId() `AWS::IdentityStore::Group.IdentityStoreId`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) A string containing the description of the group.
void	setDisplayName(java.lang.String value) `AWS::IdentityStore::Group.DisplayName`.
void	setIdentityStoreId(java.lang.String value) `AWS::IdentityStore::Group.IdentityStoreId`.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnGroup

protected CfnGroup(software.amazon.jsii.JsiiObjectRef objRef)

CfnGroup

protected CfnGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnGroup

public CfnGroup(Construct scope,
                java.lang.String id,
                CfnGroupProps props)

Create a new `AWS::IdentityStore::Group`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrGroupId

public java.lang.String getAttrGroupId()

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDisplayName

public java.lang.String getDisplayName()

`AWS::IdentityStore::Group.DisplayName`.

setDisplayName

public void setDisplayName(java.lang.String value)

`AWS::IdentityStore::Group.DisplayName`.

getIdentityStoreId

public java.lang.String getIdentityStoreId()

`AWS::IdentityStore::Group.IdentityStoreId`.

setIdentityStoreId

public void setIdentityStoreId(java.lang.String value)

`AWS::IdentityStore::Group.IdentityStoreId`.

getDescription

public java.lang.String getDescription()

A string containing the description of the group.

setDescription

public void setDescription(java.lang.String value)

A string containing the description of the group.