1. Packages
  2. AWS Native
  3. API Docs
  4. cloudtrail
  5. getChannel

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.cloudtrail.getChannel

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    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.

    Using getChannel

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getChannel(args: GetChannelArgs, opts?: InvokeOptions): Promise<GetChannelResult>
    function getChannelOutput(args: GetChannelOutputArgs, opts?: InvokeOptions): Output<GetChannelResult>
    def get_channel(channel_arn: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetChannelResult
    def get_channel_output(channel_arn: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetChannelResult]
    func LookupChannel(ctx *Context, args *LookupChannelArgs, opts ...InvokeOption) (*LookupChannelResult, error)
    func LookupChannelOutput(ctx *Context, args *LookupChannelOutputArgs, opts ...InvokeOption) LookupChannelResultOutput

    > Note: This function is named LookupChannel in the Go SDK.

    public static class GetChannel 
    {
        public static Task<GetChannelResult> InvokeAsync(GetChannelArgs args, InvokeOptions? opts = null)
        public static Output<GetChannelResult> Invoke(GetChannelInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetChannelResult> getChannel(GetChannelArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:cloudtrail:getChannel
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ChannelArn string
    Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
    ChannelArn string
    Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
    channelArn String
    Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
    channelArn string
    Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
    channel_arn str
    Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
    channelArn String
    Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .

    getChannel Result

    The following output properties are available:

    ChannelArn string
    Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
    Destinations List<Pulumi.AwsNative.CloudTrail.Outputs.ChannelDestination>
    One or more resources to which events arriving through a channel are logged and stored.
    Name string
    The name of the channel.
    ChannelArn string
    Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
    Destinations []ChannelDestination
    One or more resources to which events arriving through a channel are logged and stored.
    Name string
    The name of the channel.
    channelArn String
    Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
    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.
    channelArn string
    Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
    destinations ChannelDestination[]
    One or more resources to which events arriving through a channel are logged and stored.
    name string
    The name of the channel.
    channel_arn str
    Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
    destinations Sequence[ChannelDestination]
    One or more resources to which events arriving through a channel are logged and stored.
    name str
    The name of the channel.
    channelArn String
    Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .
    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.

    Supporting Types

    ChannelDestination

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

    ChannelDestinationType

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi