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) – A string containing the name of the group. This value is commonly displayed when the group is referenced.

  • 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

A string containing the name of the group.

This value is commonly displayed when the group is referenced.

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