Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cloudtrail
  5. Channel

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.cloudtrail.Channel

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

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.

Create Channel Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Channel(name: string, args?: ChannelArgs, opts?: CustomResourceOptions);
@overload
def Channel(resource_name: str,
            args: Optional[ChannelArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def Channel(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            destinations: Optional[Sequence[ChannelDestinationArgs]] = None,
            name: Optional[str] = None,
            source: Optional[str] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewChannel(ctx *Context, name string, args *ChannelArgs, opts ...ResourceOption) (*Channel, error)
public Channel(string name, ChannelArgs? args = null, CustomResourceOptions? opts = null)
public Channel(String name, ChannelArgs args)
public Channel(String name, ChannelArgs args, CustomResourceOptions options)

type: aws-native:cloudtrail:Channel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args ChannelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args ChannelArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args ChannelArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args ChannelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ChannelArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Channel Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Channel resource accepts the following input properties:

Destinations List<Pulumi.AwsNative.CloudTrail.Inputs.ChannelDestination>
One or more resources to which events arriving through a channel are logged and stored.
Name string
The name of the channel.
Source string
The ARN of an on-premises storage solution or application, or a partner event source.
Tags List<Pulumi.AwsNative.Inputs.Tag>
An array of key-value pairs to apply to this resource.
Destinations []ChannelDestinationArgs
One or more resources to which events arriving through a channel are logged and stored.
Name string
The name of the channel.
Source string
The ARN of an on-premises storage solution or application, or a partner event source.
Tags TagArgs
An array of key-value pairs to apply to this resource.
destinations List<ChannelDestination>
One or more resources to which events arriving through a channel are logged and stored.
name String
The name of the channel.
source String
The ARN of an on-premises storage solution or application, or a partner event source.
tags List<Tag>
An array of key-value pairs to apply to this resource.
destinations ChannelDestination[]
One or more resources to which events arriving through a channel are logged and stored.
name string
The name of the channel.
source string
The ARN of an on-premises storage solution or application, or a partner event source.
tags Tag[]
An array of key-value pairs to apply to this resource.
destinations Sequence[ChannelDestinationArgs]
One or more resources to which events arriving through a channel are logged and stored.
name str
The name of the channel.
source str
The ARN of an on-premises storage solution or application, or a partner event source.
tags Sequence[TagArgs]
An array of key-value pairs to apply to this resource.
destinations List<Property Map>
One or more resources to which events arriving through a channel are logged and stored.
name String
The name of the channel.
source String
The ARN of an on-premises storage solution or application, or a partner event source.
tags List<Property Map>
An array of key-value pairs to apply to this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Channel resource produces the following output properties:

ChannelArn string
Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
Id string
The provider-assigned unique ID for this managed resource.
ChannelArn string
Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
Id string
The provider-assigned unique ID for this managed resource.
channelArn String
Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
id String
The provider-assigned unique ID for this managed resource.
channelArn string
Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
id string
The provider-assigned unique ID for this managed resource.
channel_arn str
Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
id str
The provider-assigned unique ID for this managed resource.
channelArn String
Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

ChannelDestination
, ChannelDestinationArgs

Location This property is required. string
The ARN of a resource that receives events from a channel.
Type This property is required. Pulumi.AwsNative.CloudTrail.ChannelDestinationType
The type of destination for events arriving from a channel.
Location This property is required. string
The ARN of a resource that receives events from a channel.
Type This property is required. ChannelDestinationType
The type of destination for events arriving from a channel.
location This property is required. String
The ARN of a resource that receives events from a channel.
type This property is required. ChannelDestinationType
The type of destination for events arriving from a channel.
location This property is required. string
The ARN of a resource that receives events from a channel.
type This property is required. ChannelDestinationType
The type of destination for events arriving from a channel.
location This property is required. str
The ARN of a resource that receives events from a channel.
type This property is required. ChannelDestinationType
The type of destination for events arriving from a channel.
location This property is required. String
The ARN of a resource that receives events from a channel.
type This property is required. "EVENT_DATA_STORE"
The type of destination for events arriving from a channel.

ChannelDestinationType
, ChannelDestinationTypeArgs

EventDataStore
EVENT_DATA_STORE
ChannelDestinationTypeEventDataStore
EVENT_DATA_STORE
EventDataStore
EVENT_DATA_STORE
EventDataStore
EVENT_DATA_STORE
EVENT_DATA_STORE
EVENT_DATA_STORE
"EVENT_DATA_STORE"
EVENT_DATA_STORE

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native