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	awscc.guardduty.members

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
member_id	string
detector_id	string
region	string	AWS region.

For more information, see AWS::GuardDuty::Member.

Methods

Name	Resource	Accessible by	Required Params
create_resource	members	INSERT	Email, region
delete_resource	members	DELETE	Identifier, region
update_resource	members	UPDATE	Identifier, PatchDocument, region
list_resources	members_list_only	SELECT	region
get_resource	members	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual member.

SELECT
  region,
  status,
  member_id,
  email,
  message,
  disable_email_notification,
  detector_id
FROM awscc.guardduty.members
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ detector_id }}|{{ member_id }}';

list (identifiers only)

Lists all members in a region.

SELECT
  region,
  detector_id,
  member_id
FROM awscc.guardduty.members_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.guardduty.members (
  Status,
  MemberId,
  Email,
  Message,
  DisableEmailNotification,
  DetectorId,
  region
)
SELECT
  '{{ status }}',
  '{{ member_id }}',
  '{{ email }}',
  '{{ message }}',
  '{{ disable_email_notification }}',
  '{{ detector_id }}',
  '{{ 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: member_id
        value: '{{ member_id }}'
      - name: email
        value: '{{ email }}'
      - name: message
        value: '{{ message }}'
      - name: disable_email_notification
        value: '{{ disable_email_notification }}'
      - name: detector_id
        value: '{{ detector_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.guardduty.members
SET PatchDocument = string('{{ {
    "Status": status,
    "Email": email,
    "Message": message,
    "DisableEmailNotification": disable_email_notification
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ detector_id }}|{{ member_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.guardduty.members
WHERE
  Identifier = '{{ detector_id }}|{{ member_id }}' 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