interface CfnGroupProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.IdentityStore.CfnGroupProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsidentitystore#CfnGroupProps |
![]() | software.amazon.awscdk.services.identitystore.CfnGroupProps |
![]() | aws_cdk.aws_identitystore.CfnGroupProps |
![]() | aws-cdk-lib » aws_identitystore » CfnGroupProps |
Properties for defining a CfnGroup
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_identitystore as identitystore } from 'aws-cdk-lib';
const cfnGroupProps: identitystore.CfnGroupProps = {
displayName: 'displayName',
identityStoreId: 'identityStoreId',
// the properties below are optional
description: 'description',
};
Properties
Name | Type | Description |
---|---|---|
display | string | The display name value for the group. |
identity | string | The globally unique identifier for the identity store. |
description? | string | A string containing the description of the group. |
displayName
Type:
string
The display name value for the group.
The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
Prefix search supports a maximum of 1,000 characters for the string.
identityStoreId
Type:
string
The globally unique identifier for the identity store.
description?
Type:
string
(optional)
A string containing the description of the group.