AWS AWSCloudFormation documentation change
Summary
Updated member ID description, added examples, and clarified return values for GroupMembership resource
Security assessment
Documentation clarifications and example additions without security context or vulnerability fixes
Diff
diff --git a/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-groupmembership.md b/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-groupmembership.md index 0e2eab5f1..242dcfffd 100644 --- a/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-groupmembership.md +++ b/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-groupmembership.md @@ -3 +3 @@ -SyntaxPropertiesReturn values +SyntaxPropertiesReturn valuesExamples @@ -76 +76 @@ _Minimum_ : `1` -An object that contains the identifier of a group member. Setting the `UserID` field to the specific identifier for a user indicates that the user is a member of the group. +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. @@ -87,0 +88,2 @@ _Required_ : Yes +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`. + @@ -89,0 +92,4 @@ _Required_ : Yes +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`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). + @@ -95 +101,34 @@ _Required_ : Yes -The identifier for a `GroupMembership` object in an identity store. +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" +