Skip to content

Create Channel

cloudtrail_create_channel R Documentation

Creates a channel for CloudTrail to ingest events from a partner or external source

Description

Creates a channel for CloudTrail to ingest events from a partner or external source. After you create a channel, a CloudTrail Lake event data store can log events from the partner or source that you specify.

Usage

cloudtrail_create_channel(Name, Source, Destinations, Tags)

Arguments

Name

[required] The name of the channel.

Source

[required] The name of the partner or external event source. You cannot change this name after you create the channel. A maximum of one channel is allowed per source.

A source can be either Custom for all valid non-Amazon Web Services events, or the name of a partner event source. For information about the source names for available partners, see Additional information about integration partners in the CloudTrail User Guide.

Destinations

[required] One or more event data stores to which events arriving through a channel will be logged.

Tags

Value

A list with the following syntax:

list(
  ChannelArn = "string",
  Name = "string",
  Source = "string",
  Destinations = list(
    list(
      Type = "EVENT_DATA_STORE"|"AWS_SERVICE",
      Location = "string"
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Request syntax

svc$create_channel(
  Name = "string",
  Source = "string",
  Destinations = list(
    list(
      Type = "EVENT_DATA_STORE"|"AWS_SERVICE",
      Location = "string"
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)