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	aws.cloudtrail.channels

Fields

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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	, 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 channels in a region.

SELECT
region,
name,
source,
destinations,
channel_arn,
tags
FROM aws.cloudtrail.channels
WHERE region = 'us-east-1';

Gets all properties from an individual channel.

SELECT
region,
name,
source,
destinations,
channel_arn,
tags
FROM aws.cloudtrail.channels
WHERE region = 'us-east-1' AND data__Identifier = '<ChannelArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.cloudtrail.channels (
 ,
 region
)
SELECT 
'{{  }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cloudtrail.channels (
 Name,
 Source,
 Destinations,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Source }}',
 '{{ Destinations }}',
 '{{ Tags }}',
 '{{ region }}';

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:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.cloudtrail.channels
WHERE data__Identifier = '<ChannelArn>'
AND region = 'us-east-1';

Permissions

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

Create

CloudTrail:CreateChannel,
CloudTrail:AddTags

Read

CloudTrail:GetChannel,
CloudTrail:ListChannels

Update

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

Delete

CloudTrail:DeleteChannel

List

CloudTrail:ListChannels