AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . cloudtrail ]
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.
See also: AWS API Documentation
create-channel
--name <value>
--source <value>
--destinations <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--name
(string)
The name of the channel.
--source
(string)
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
(list)
One or more event data stores to which events arriving through a channel will be logged.
(structure)
Contains information about the destination receiving events.
Type -> (string)
The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value isEVENT_DATA_STORE
. For service-linked channels, the value isAWS_SERVICE
.Location -> (string)
For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel. For service-linked channels, the location is the name of the Amazon Web Services service.
Shorthand Syntax:
Type=string,Location=string ...
JSON Syntax:
[
{
"Type": "EVENT_DATA_STORE"|"AWS_SERVICE",
"Location": "string"
}
...
]
--tags
(list)
A list of tags.
(structure)
A custom key-value pair associated with a resource such as a CloudTrail trail, event data store, dashboard, or channel.
Key -> (string)
The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.Value -> (string)
The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
ChannelArn -> (string)
The Amazon Resource Name (ARN) of the new channel.
Name -> (string)
The name of the new channel.
Source -> (string)
The partner or external event source name.
Destinations -> (list)
The event data stores that log the events arriving through the channel.
(structure)
Contains information about the destination receiving events.
Type -> (string)
The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value isEVENT_DATA_STORE
. For service-linked channels, the value isAWS_SERVICE
.Location -> (string)
For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel. For service-linked channels, the location is the name of the Amazon Web Services service.
Tags -> (list)
A list of tags.
(structure)
A custom key-value pair associated with a resource such as a CloudTrail trail, event data store, dashboard, or channel.
Key -> (string)
The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.Value -> (string)
The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.