create_channel¶
Operation¶
async
¶
create_channel(input: CreateChannelInput, plugins: list[Plugin] | None = None) -> CreateChannelOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateChannelInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateChannelOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateChannelInput structure.
Attributes¶
class-attribute
instance-attribute
¶
destinations: list[Destination] | None = None
One or more event data stores to which events arriving through a channel will be logged.
class-attribute
instance-attribute
¶
source: str | None = None
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.
Output¶
dataclass
¶
Dataclass for CreateChannelOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
channel_arn: str | None = None
The Amazon Resource Name (ARN) of the new channel.
class-attribute
instance-attribute
¶
destinations: list[Destination] | None = None
The event data stores that log the events arriving through the channel.