Package software.amazon.awscdk.services.identitystore

Interface CfnGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-01-03T18:29:27.497Z")
@Stability(Stable)
public interface CfnGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGroup.

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.*;
 CfnGroupProps cfnGroupProps = CfnGroupProps.builder()
         .displayName("displayName")
         .identityStoreId("identityStoreId")
         // the properties below are optional
         .description("description")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGroupProps.Builder	A builder for CfnGroupProps
static final class	CfnGroupProps.Jsii$Proxy	An implementation for CfnGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnGroupProps.Builder	builder()
default String	getDescription()	A string containing the description of the group.
String	getDisplayName()	A string containing the name of the group.
String	getIdentityStoreId()	The globally unique identifier for the identity store.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDisplayName

@Stability(Stable)
@NotNull
String getDisplayName()

A string containing the name of the group.

This value is commonly displayed when the group is referenced.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html#cfn-identitystore-group-displayname

getIdentityStoreId

@Stability(Stable)
@NotNull
String getIdentityStoreId()

The globally unique identifier for the identity store.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html#cfn-identitystore-group-identitystoreid

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A string containing the description of the group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html#cfn-identitystore-group-description

builder

@Stability(Stable)
static CfnGroupProps.Builder builder()

Returns:

a CfnGroupProps.Builder of CfnGroupProps