CfnGroupProps

class aws_cdk.aws_identitystore.CfnGroupProps(*, display_name, identity_store_id, description=None)

Bases: object

Properties for defining a CfnGroup.

Parameters:

display_name (str) – 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.
identity_store_id (str) – The globally unique identifier for the identity store.
description (Optional[str]) – A string containing the description of the group.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_identitystore as identitystore

cfn_group_props = identitystore.CfnGroupProps(
    display_name="displayName",
    identity_store_id="identityStoreId",

    # the properties below are optional
    description="description"
)

Attributes

description

A string containing the description of the group.

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

display_name

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.

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

identity_store_id

The globally unique identifier for the identity store.

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