AWS::IdentityStore::Group - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::IdentityStore::Group

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IdentityStore::Group",
  "Properties" : {
      "Description" : String,
      "DisplayName" : String,
      "IdentityStoreId" : String
    }
}

YAML

Type: AWS::IdentityStore::Group
Properties:
  Description: String
  DisplayName: String
  IdentityStoreId: String

Properties

Description

A string containing the description of the group.

Required: No

Type: String

Pattern: ^[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+$

Minimum: 1

Maximum: 1024

Update requires: No interruption

DisplayName

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.

Required: Yes

Type: String

Pattern: ^[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+$

Minimum: 1

Maximum: 1024

Update requires: No interruption

IdentityStoreId

The globally unique identifier for the identity store.

Required: Yes

Type: String

Pattern: ^d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Minimum: 1

Maximum: 36

Update requires: Replacement

Return values

Ref

Fn::GetAtt

GroupId

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