masters

Creates, updates, deletes or gets a master resource or lists masters in a region

Overview

Name	masters
Type	Resource
Description	GuardDuty Master resource schema
Id	awscc.guardduty.masters

Fields

get (all properties)

Name	Datatype	Description
master_id	string	ID of the account used as the master account.
invitation_id	string	Value used to validate the master account to the member account.
detector_id	string	Unique ID of the detector of the GuardDuty member account.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
master_id	string	ID of the account used as the master account.
detector_id	string	Unique ID of the detector of the GuardDuty member account.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	masters	INSERT	MasterId, DetectorId, region
delete_resource	masters	DELETE	Identifier, region
list_resources	masters_list_only	SELECT	region
get_resource	masters	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual master.

SELECT
  region,
  master_id,
  invitation_id,
  detector_id
FROM awscc.guardduty.masters
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ detector_id }}|{{ master_id }}';

list (identifiers only)

Lists all masters in a region.

SELECT
  region,
  detector_id,
  master_id
FROM awscc.guardduty.masters_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.guardduty.masters (
  MasterId,
  DetectorId,
  region
)
SELECT
  '{{ master_id }}',
  '{{ detector_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.guardduty.masters (
  MasterId,
  InvitationId,
  DetectorId,
  region
)
SELECT
  '{{ master_id }}',
  '{{ invitation_id }}',
  '{{ detector_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: master
  props:
    - name: master_id
      value: '{{ master_id }}'
    - name: invitation_id
      value: '{{ invitation_id }}'
    - name: detector_id
      value: '{{ detector_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.guardduty.masters
WHERE
  Identifier = '{{ detector_id }}|{{ master_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

guardduty:ListInvitations,
guardduty:AcceptInvitation,
guardduty:GetMasterAccount

Read

guardduty:GetMasterAccount

Delete

guardduty:DisassociateFromMasterAccount

List

guardduty:GetMasterAccount