channels

Creates, updates, deletes or gets a channel resource or lists channels in a region

Overview

Name	channels
Type	Resource
Description	A channel receives events from a specific source (such as an on-premises storage solution or application, or a partner event data source), and delivers the events to one or more event data stores. You use channels to ingest events into CloudTrail from sources outside AWS.
Id	awscc.cloudtrail.channels

Fields

get (all properties)

Name	Datatype	Description
name	string	The name of the channel.
source	string	The ARN of an on-premises storage solution or application, or a partner event source.
▶destinations	array	One or more resources to which events arriving through a channel are logged and stored.
channel_arn	string	The Amazon Resource Name (ARN) of a channel.
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
channel_arn	string	The Amazon Resource Name (ARN) of a channel.
region	string	AWS region.

For more information, see AWS::CloudTrail::Channel.

Methods

Name	Resource	Accessible by	Required Params
create_resource	channels	INSERT	, region
delete_resource	channels	DELETE	Identifier, region
update_resource	channels	UPDATE	Identifier, PatchDocument, region
list_resources	channels_list_only	SELECT	region
get_resource	channels	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual channel.

SELECT
  region,
  name,
  source,
  destinations,
  channel_arn,
  tags
FROM awscc.cloudtrail.channels
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ channel_arn }}';

list (identifiers only)

Lists all channels in a region.

SELECT
  region,
  channel_arn
FROM awscc.cloudtrail.channels_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.cloudtrail.channels (
  ,
  region
)
SELECT
  '{{  }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.cloudtrail.channels (
  Name,
  Source,
  Destinations,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ source }}',
  '{{ destinations }}',
  '{{ 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: channel
  props:
    - name: name
      value: '{{ name }}'
    - name: source
      value: '{{ source }}'
    - name: destinations
      value:
        - type: '{{ type }}'
          location: '{{ location }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'

UPDATE example

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

/*+ update */
UPDATE awscc.cloudtrail.channels
SET PatchDocument = string('{{ {
    "Name": name,
    "Destinations": destinations,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ channel_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

CloudTrail:CreateChannel,
CloudTrail:AddTags

Read

CloudTrail:GetChannel,
CloudTrail:ListChannels,
CloudTrail:ListTags

Update

CloudTrail:UpdateChannel,
CloudTrail:GetChannel,
CloudTrail:AddTags,
CloudTrail:RemoveTags

Delete

CloudTrail:DeleteChannel

List

CloudTrail:ListChannels