AWS AWSCloudFormation documentation change
Summary
Updated descriptions, added examples, and clarified return values for Identity Store Group resource
Security assessment
General documentation improvements with no security-specific changes or vulnerability references
Diff
diff --git a/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.md b/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.md index a6faafdb9..de1c87388 100644 --- a/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.md +++ b/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.md @@ -3 +3 @@ -SyntaxPropertiesReturn values +SyntaxPropertiesReturn valuesExamples @@ -7 +7 @@ SyntaxPropertiesReturn values -A group object that contains the metadata and attributes for a specified group. +A group object, which contains a specified group’s metadata and attributes. @@ -41 +41 @@ To declare this entity in your AWS CloudFormation template, use the following sy -A string containing a description of the specified group. +A string containing the description of the group. @@ -94,0 +95,2 @@ _Minimum_ : `1` +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 `GroupID|IdentityStoreId`. + @@ -96,0 +99,4 @@ _Minimum_ : `1` +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). + @@ -102 +108,35 @@ _Minimum_ : `1` -The identifier for a group in the identity store. +The identifier of the newly created group in the identity store. + +## Examples + +### Declare a Identity Store Resource + +The following example shows how to create a Identity Store `Group` resource: + +#### JSON + + + { + "Type": "AWS::IdentityStore::Group", + "Properties": { + "Description": { + "description": "Group for developers", + }, + "DisplayName": { + "description": "Developers", + }, + "IdentityStoreId": { + "description": "d-1111111111", + + } + } + +#### YAML + + + Type: AWS::IdentityStore::Group + Properties: + Description: "Group for Developers" + DisplayName: "Developers" + IdentityStoreId: "d-1111111111a" +