group_members

Creates, updates, deletes, gets or lists a group_members resource.

Overview

Name	group_members
Type	Resource
Id	aws.ds_data.group_members

Fields

The following fields are returned by SELECT queries:

list_group_members

Name	Datatype	Description
member_type	string	The AD type of the member object. (USER, GROUP, COMPUTER)
sam_account_name	string	The name of the group member. (pattern: <code>^[^:;|=+"*?<>/\,&#91;&#93;@]+$</code>)
sid	string	The unique security identifier (SID) of the group member.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_group_members	select	DirectoryId, region		Returns member information for the specified group. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListGroupMembers.NextToken member contains a token that you pass in the next call to ListGroupMembers. This retrieves the next set of items. You can also specify a maximum number of return results with the MaxResults parameter.
add_group_member	update	DirectoryId, region, GroupName, MemberName		Adds an existing user, group, or computer as a group member.
remove_group_member	exec	DirectoryId, region, GroupName, MemberName		Removes a member from a group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
DirectoryId	string	The identifier (ID) of the directory that's associated with the member.
region	string	AWS region (default: us-east-1)

SELECT examples

list_group_members

Returns member information for the specified group. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListGroupMembers.NextToken member contains a token that you pass in the next call to ListGroupMembers. This retrieves the next set of items. You can also specify a maximum number of return results with the MaxResults parameter.

SELECT
member_type,
sam_account_name,
sid
FROM aws.ds_data.group_members
WHERE DirectoryId = '{{ DirectoryId }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

add_group_member

Adds an existing user, group, or computer as a group member.

UPDATE aws.ds_data.group_members
SET 
ClientToken = '{{ ClientToken }}',
GroupName = '{{ GroupName }}',
MemberName = '{{ MemberName }}',
MemberRealm = '{{ MemberRealm }}'
WHERE 
DirectoryId = '{{ DirectoryId }}' --required
AND region = '{{ region }}' --required
AND GroupName = '{{ GroupName }}' --required
AND MemberName = '{{ MemberName }}' --required;

Lifecycle Methods

remove_group_member

Removes a member from a group.

EXEC aws.ds_data.group_members.remove_group_member 
@DirectoryId='{{ DirectoryId }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"ClientToken": "{{ ClientToken }}", 
"GroupName": "{{ GroupName }}", 
"MemberName": "{{ MemberName }}", 
"MemberRealm": "{{ MemberRealm }}"
}'
;