publishing_destinations

Creates, updates, deletes or gets a publishing_destination resource or lists publishing_destinations in a region

Overview

Name	publishing_destinations
Type	Resource
Description	Resource Type definition for AWS::GuardDuty::PublishingDestination.
Id	awscc.guardduty.publishing_destinations

Fields

get (all properties)

Name	Datatype	Description
id	string	The ID of the publishing destination.
detector_id	string	The ID of the GuardDuty detector associated with the publishing destination.
destination_type	string	The type of resource for the publishing destination. Currently only Amazon S3 buckets are supported.
▶destination_properties	object
status	string	The status of the publishing destination.
publishing_failure_start_timestamp	string	The time, in epoch millisecond format, at which GuardDuty was first unable to publish findings to the destination.
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	The ID of the publishing destination.
detector_id	string	The ID of the GuardDuty detector associated with the publishing destination.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	publishing_destinations	INSERT	DetectorId, DestinationType, DestinationProperties, region
delete_resource	publishing_destinations	DELETE	Identifier, region
update_resource	publishing_destinations	UPDATE	Identifier, PatchDocument, region
list_resources	publishing_destinations_list_only	SELECT	region
get_resource	publishing_destinations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual publishing_destination.

SELECT
  region,
  id,
  detector_id,
  destination_type,
  destination_properties,
  status,
  publishing_failure_start_timestamp,
  tags
FROM awscc.guardduty.publishing_destinations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ detector_id }}|{{ id }}';

list (identifiers only)

Lists all publishing_destinations in a region.

SELECT
  region,
  detector_id,
  id
FROM awscc.guardduty.publishing_destinations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.guardduty.publishing_destinations (
  DetectorId,
  DestinationType,
  DestinationProperties,
  region
)
SELECT
  '{{ detector_id }}',
  '{{ destination_type }}',
  '{{ destination_properties }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.guardduty.publishing_destinations (
  DetectorId,
  DestinationType,
  DestinationProperties,
  Tags,
  region
)
SELECT
  '{{ detector_id }}',
  '{{ destination_type }}',
  '{{ destination_properties }}',
  '{{ tags }}',
  '{{ 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: publishing_destination
  props:
    - name: detector_id
      value: '{{ detector_id }}'
    - name: destination_type
      value: '{{ destination_type }}'
    - name: destination_properties
      value:
        destination_arn: '{{ destination_arn }}'
        kms_key_arn: '{{ kms_key_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.guardduty.publishing_destinations
SET PatchDocument = string('{{ {
    "DestinationType": destination_type,
    "DestinationProperties": destination_properties,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ detector_id }}|{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.guardduty.publishing_destinations
WHERE
  Identifier = '{{ detector_id }}|{{ 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 publishing_destinations resource, the following permissions are required:

Create

guardduty:CreatePublishingDestination,
guardduty:TagResource,
guardduty:DescribePublishingDestination,
guardduty:ListTagsForResource

Read

guardduty:DescribePublishingDestination,
guardduty:ListTagsForResource

Update

guardduty:UpdatePublishingDestination,
guardduty:TagResource,
guardduty:UntagResource,
guardduty:ListTagsForResource,
guardduty:DescribePublishingDestination

Delete

guardduty:DeletePublishingDestination,
guardduty:DescribePublishingDestination

List

guardduty:ListPublishingDestinations