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

Property description not available.

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

Property description not available.

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.