members

Creates, updates, deletes or gets a member resource or lists members in a region

Overview

Name	members
Type	Resource
Description	Resource Type definition for AWS::GuardDuty::Member
Id	aws.guardduty.members

Fields

Name	Datatype	Description
status	string
member_id	string
email	string
message	string
disable_email_notification	boolean
detector_id	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Email, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all members in a region.

SELECT
region,
status,
member_id,
email,
message,
disable_email_notification,
detector_id
FROM aws.guardduty.members
WHERE region = 'us-east-1';

Gets all properties from an individual member.

SELECT
region,
status,
member_id,
email,
message,
disable_email_notification,
detector_id
FROM aws.guardduty.members
WHERE region = 'us-east-1' AND data__Identifier = '<DetectorId>|<MemberId>';

INSERT example

Use the following StackQL query and manifest file to create a new member resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.guardduty.members (
 Email,
 region
)
SELECT 
'{{ Email }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.guardduty.members (
 Status,
 MemberId,
 Email,
 Message,
 DisableEmailNotification,
 DetectorId,
 region
)
SELECT 
 '{{ Status }}',
 '{{ MemberId }}',
 '{{ Email }}',
 '{{ Message }}',
 '{{ DisableEmailNotification }}',
 '{{ DetectorId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: member
    props:
      - name: Status
        value: '{{ Status }}'
      - name: MemberId
        value: '{{ MemberId }}'
      - name: Email
        value: '{{ Email }}'
      - name: Message
        value: '{{ Message }}'
      - name: DisableEmailNotification
        value: '{{ DisableEmailNotification }}'
      - name: DetectorId
        value: '{{ DetectorId }}'

DELETE example

/*+ delete */
DELETE FROM aws.guardduty.members
WHERE data__Identifier = '<DetectorId|MemberId>'
AND region = 'us-east-1';

Permissions

To operate on the members resource, the following permissions are required:

Create

guardduty:CreateMembers,
guardduty:GetMembers

Read

guardduty:GetMembers

Delete

guardduty:GetMembers,
guardduty:DisassociateMembers,
guardduty:DeleteMembers

Update

guardduty:GetMembers,
guardduty:CreateMembers,
guardduty:DisassociateMembers,
guardduty:StartMonitoringMembers,
guardduty:StopMonitoringMembers,
guardduty:InviteMembers

List

guardduty:ListMembers