AWS::IdentityStore::GroupMembership - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::IdentityStore::GroupMembership

Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.

Syntax

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

JSON

{
  "Type" : "AWS::IdentityStore::GroupMembership",
  "Properties" : {
      "GroupId" : String,
      "IdentityStoreId" : String,
      "MemberId" : MemberId
    }
}

YAML

Type: AWS::IdentityStore::GroupMembership
Properties:
  GroupId: String
  IdentityStoreId: String
  MemberId: 
    MemberId

Properties

GroupId

The identifier for a group in the identity store.

Required: Yes

Type: String

Pattern: ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$

Minimum: 1

Maximum: 47

Update requires: Replacement

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

MemberId

An object containing the identifier of a group member. Setting the MemberId's UserId field to a specific User's ID indicates that user is a member of the group.

Required: Yes

Type: MemberId

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Physical ID of the resource created which is the format GroupMembershipID|IdentityStoreId.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

MembershipId

The identifier for a GroupMembership in the identity store.

Examples

Declare a Identity Store Resource

The following example shows how to create a Identity Store Group Membership resource:

JSON

{
  "Type": "AWS::IdentityStore::GroupMembership",
  "Properties": {
    "GroupId": {
      "description": "g-1111111111-2222-3333-4444-5555-6666666656",
    },
    "IdentityStoreId": {
      "description": "d-1111111111",
    },
    "MemberId": {
      "description": "m-1111111112-2222-3333-4444-5555-6666666656",
    }
  }

YAML

Type: AWS::IdentityStore::GroupMembership
    Properties:
      GroupId: "g-1111111111-2222-3333-4444-5555-6666666656"
      IdentityStoreId: "d-1111111111"
      MemberId: "m-1111111112-2222-3333-4444-5555-6666666656"