Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. kinesis
  6. getChannel

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

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.kinesis.getChannel

aws-native logo aws-native logo

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

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Kinesis::Channel

    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?: InvokeOutputOptions): Output<GetChannelResult>
    def get_channel(channel_arn: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetChannelResult
def get_channel_output(channel_arn: pulumi.Input[Optional[str]] = None,
                opts: Optional[InvokeOutputOptions] = 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 Output<GetChannelResult> Invoke(GetChannelInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetChannelResult> getChannel(GetChannelArgs args, InvokeOptions options)
public static Output<GetChannelResult> getChannel(GetChannelArgs args, InvokeOptions options)
public static Output<GetChannelResult> getChannel(GetChannelArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:kinesis:getChannel
  arguments:
    # arguments dictionary
    data "aws-native_kinesis_get_channel" "name" {
    # arguments
}

    The following arguments are supported:

    ChannelArn string
    The ARN of the channel.
    ChannelArn string
    The ARN of the channel.
    channel_arn string
    The ARN of the channel.
    channelArn String
    The ARN of the channel.
    channelArn string
    The ARN of the channel.
    channel_arn str
    The ARN of the channel.
    channelArn String
    The ARN of the channel.

    getChannel Result

    The following output properties are available:

    ChannelArn string
    The ARN of the channel.
    ChannelCreationTimestamp string
    Timestamp of when the channel was created.
    ChannelId string
    The service-generated unique identifier for the channel.
    ChannelStatus Pulumi.AwsNative.Kinesis.ChannelStatus
    The status of the channel.
    LoggingConfiguration Pulumi.AwsNative.Kinesis.Outputs.ChannelLoggingConfiguration
    Configuration for delivering channel operational logs. Defaults to CloudWatch Logs disabled.
    S3DestinationConfiguration Pulumi.AwsNative.Kinesis.Outputs.ChannelS3DestinationConfiguration
    Configuration for delivery to a vanilla S3 bucket destination. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified.
    S3TablesDestinationConfiguration Pulumi.AwsNative.Kinesis.Outputs.ChannelS3TablesDestinationConfiguration
    Configuration for delivery to S3 Tables destinations. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.
    ChannelArn string
    The ARN of the channel.
    ChannelCreationTimestamp string
    Timestamp of when the channel was created.
    ChannelId string
    The service-generated unique identifier for the channel.
    ChannelStatus ChannelStatus
    The status of the channel.
    LoggingConfiguration ChannelLoggingConfiguration
    Configuration for delivering channel operational logs. Defaults to CloudWatch Logs disabled.
    S3DestinationConfiguration ChannelS3DestinationConfiguration
    Configuration for delivery to a vanilla S3 bucket destination. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified.
    S3TablesDestinationConfiguration ChannelS3TablesDestinationConfiguration
    Configuration for delivery to S3 Tables destinations. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified.
    Tags Tag
    An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.
    channel_arn string
    The ARN of the channel.
    channel_creation_timestamp string
    Timestamp of when the channel was created.
    channel_id string
    The service-generated unique identifier for the channel.
    channel_status "CREATING" | "ACTIVE" | "UPDATING" | "DELETING" | "FAILED"
    The status of the channel.
    logging_configuration object
    Configuration for delivering channel operational logs. Defaults to CloudWatch Logs disabled.
    s3_destination_configuration object
    Configuration for delivery to a vanilla S3 bucket destination. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified.
    s3_tables_destination_configuration object
    Configuration for delivery to S3 Tables destinations. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified.
    tags list(object)
    An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.
    channelArn String
    The ARN of the channel.
    channelCreationTimestamp String
    Timestamp of when the channel was created.
    channelId String
    The service-generated unique identifier for the channel.
    channelStatus ChannelStatus
    The status of the channel.
    loggingConfiguration ChannelLoggingConfiguration
    Configuration for delivering channel operational logs. Defaults to CloudWatch Logs disabled.
    s3DestinationConfiguration ChannelS3DestinationConfiguration
    Configuration for delivery to a vanilla S3 bucket destination. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified.
    s3TablesDestinationConfiguration ChannelS3TablesDestinationConfiguration
    Configuration for delivery to S3 Tables destinations. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified.
    tags List<Tag>
    An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.
    channelArn string
    The ARN of the channel.
    channelCreationTimestamp string
    Timestamp of when the channel was created.
    channelId string
    The service-generated unique identifier for the channel.
    channelStatus ChannelStatus
    The status of the channel.
    loggingConfiguration ChannelLoggingConfiguration
    Configuration for delivering channel operational logs. Defaults to CloudWatch Logs disabled.
    s3DestinationConfiguration ChannelS3DestinationConfiguration
    Configuration for delivery to a vanilla S3 bucket destination. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified.
    s3TablesDestinationConfiguration ChannelS3TablesDestinationConfiguration
    Configuration for delivery to S3 Tables destinations. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified.
    tags Tag[]
    An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.
    channel_arn str
    The ARN of the channel.
    channel_creation_timestamp str
    Timestamp of when the channel was created.
    channel_id str
    The service-generated unique identifier for the channel.
    channel_status ChannelStatus
    The status of the channel.
    logging_configuration ChannelLoggingConfiguration
    Configuration for delivering channel operational logs. Defaults to CloudWatch Logs disabled.
    s3_destination_configuration ChannelS3DestinationConfiguration
    Configuration for delivery to a vanilla S3 bucket destination. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified.
    s3_tables_destination_configuration ChannelS3TablesDestinationConfiguration
    Configuration for delivery to S3 Tables destinations. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified.
    tags Sequence[root_Tag]
    An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.
    channelArn String
    The ARN of the channel.
    channelCreationTimestamp String
    Timestamp of when the channel was created.
    channelId String
    The service-generated unique identifier for the channel.
    channelStatus "CREATING" | "ACTIVE" | "UPDATING" | "DELETING" | "FAILED"
    The status of the channel.
    loggingConfiguration Property Map
    Configuration for delivering channel operational logs. Defaults to CloudWatch Logs disabled.
    s3DestinationConfiguration Property Map
    Configuration for delivery to a vanilla S3 bucket destination. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified.
    s3TablesDestinationConfiguration Property Map
    Configuration for delivery to S3 Tables destinations. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified.
    tags List<Property Map>
    An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.

    Supporting Types

    ChannelCloudWatchLogsConfiguration

    Enabled bool
    Whether CloudWatch Logs delivery is enabled.
    LogGroupName string
    The CloudWatch log group name. When Enabled is true and LogGroupName is omitted, the service uses the default '/aws/kinesis//'.
    LogStreamName string
    The CloudWatch log stream name. Defaults to the literal string 'DestinationDelivery' when omitted.
    Enabled bool
    Whether CloudWatch Logs delivery is enabled.
    LogGroupName string
    The CloudWatch log group name. When Enabled is true and LogGroupName is omitted, the service uses the default '/aws/kinesis//'.
    LogStreamName string
    The CloudWatch log stream name. Defaults to the literal string 'DestinationDelivery' when omitted.
    enabled bool
    Whether CloudWatch Logs delivery is enabled.
    log_group_name string
    The CloudWatch log group name. When Enabled is true and LogGroupName is omitted, the service uses the default '/aws/kinesis//'.
    log_stream_name string
    The CloudWatch log stream name. Defaults to the literal string 'DestinationDelivery' when omitted.
    enabled Boolean
    Whether CloudWatch Logs delivery is enabled.
    logGroupName String
    The CloudWatch log group name. When Enabled is true and LogGroupName is omitted, the service uses the default '/aws/kinesis//'.
    logStreamName String
    The CloudWatch log stream name. Defaults to the literal string 'DestinationDelivery' when omitted.
    enabled boolean
    Whether CloudWatch Logs delivery is enabled.
    logGroupName string
    The CloudWatch log group name. When Enabled is true and LogGroupName is omitted, the service uses the default '/aws/kinesis//'.
    logStreamName string
    The CloudWatch log stream name. Defaults to the literal string 'DestinationDelivery' when omitted.
    enabled bool
    Whether CloudWatch Logs delivery is enabled.
    log_group_name str
    The CloudWatch log group name. When Enabled is true and LogGroupName is omitted, the service uses the default '/aws/kinesis//'.
    log_stream_name str
    The CloudWatch log stream name. Defaults to the literal string 'DestinationDelivery' when omitted.
    enabled Boolean
    Whether CloudWatch Logs delivery is enabled.
    logGroupName String
    The CloudWatch log group name. When Enabled is true and LogGroupName is omitted, the service uses the default '/aws/kinesis//'.
    logStreamName String
    The CloudWatch log stream name. Defaults to the literal string 'DestinationDelivery' when omitted.

    ChannelDeadLetterQueueS3Configuration

    BucketArn string
    The ARN of the S3 bucket for storing failed records.
    ExpectedBucketOwner string
    The AWS account ID of the expected owner of the dead-letter queue S3 bucket. Used to verify bucket ownership before delivery.
    ErrorOutputPrefix string
    Optional S3 key prefix under which error records are organized. When omitted, the service uses the default 'kinesis-channel/errors///'.
    BucketArn string
    The ARN of the S3 bucket for storing failed records.
    ExpectedBucketOwner string
    The AWS account ID of the expected owner of the dead-letter queue S3 bucket. Used to verify bucket ownership before delivery.
    ErrorOutputPrefix string
    Optional S3 key prefix under which error records are organized. When omitted, the service uses the default 'kinesis-channel/errors///'.
    bucket_arn string
    The ARN of the S3 bucket for storing failed records.
    expected_bucket_owner string
    The AWS account ID of the expected owner of the dead-letter queue S3 bucket. Used to verify bucket ownership before delivery.
    error_output_prefix string
    Optional S3 key prefix under which error records are organized. When omitted, the service uses the default 'kinesis-channel/errors///'.
    bucketArn String
    The ARN of the S3 bucket for storing failed records.
    expectedBucketOwner String
    The AWS account ID of the expected owner of the dead-letter queue S3 bucket. Used to verify bucket ownership before delivery.
    errorOutputPrefix String
    Optional S3 key prefix under which error records are organized. When omitted, the service uses the default 'kinesis-channel/errors///'.
    bucketArn string
    The ARN of the S3 bucket for storing failed records.
    expectedBucketOwner string
    The AWS account ID of the expected owner of the dead-letter queue S3 bucket. Used to verify bucket ownership before delivery.
    errorOutputPrefix string
    Optional S3 key prefix under which error records are organized. When omitted, the service uses the default 'kinesis-channel/errors///'.
    bucket_arn str
    The ARN of the S3 bucket for storing failed records.
    expected_bucket_owner str
    The AWS account ID of the expected owner of the dead-letter queue S3 bucket. Used to verify bucket ownership before delivery.
    error_output_prefix str
    Optional S3 key prefix under which error records are organized. When omitted, the service uses the default 'kinesis-channel/errors///'.
    bucketArn String
    The ARN of the S3 bucket for storing failed records.
    expectedBucketOwner String
    The AWS account ID of the expected owner of the dead-letter queue S3 bucket. Used to verify bucket ownership before delivery.
    errorOutputPrefix String
    Optional S3 key prefix under which error records are organized. When omitted, the service uses the default 'kinesis-channel/errors///'.

    ChannelLoggingConfiguration

    CloudWatchLogs Pulumi.AwsNative.Kinesis.Inputs.ChannelCloudWatchLogsConfiguration
    CloudWatch Logs configuration block. When provided, controls whether and where the channel writes operational logs.
    CloudWatchLogs ChannelCloudWatchLogsConfiguration
    CloudWatch Logs configuration block. When provided, controls whether and where the channel writes operational logs.
    cloud_watch_logs object
    CloudWatch Logs configuration block. When provided, controls whether and where the channel writes operational logs.
    cloudWatchLogs ChannelCloudWatchLogsConfiguration
    CloudWatch Logs configuration block. When provided, controls whether and where the channel writes operational logs.
    cloudWatchLogs ChannelCloudWatchLogsConfiguration
    CloudWatch Logs configuration block. When provided, controls whether and where the channel writes operational logs.
    cloud_watch_logs ChannelCloudWatchLogsConfiguration
    CloudWatch Logs configuration block. When provided, controls whether and where the channel writes operational logs.
    cloudWatchLogs Property Map
    CloudWatch Logs configuration block. When provided, controls whether and where the channel writes operational logs.

    ChannelPartitionField

    SourceName string
    The name of the source column on which the transform is applied.
    Transform Pulumi.AwsNative.Kinesis.ChannelPartitionFieldTransform
    The partitioning transform applied to the SourceName column.
    SourceName string
    The name of the source column on which the transform is applied.
    Transform ChannelPartitionFieldTransform
    The partitioning transform applied to the SourceName column.
    source_name string
    The name of the source column on which the transform is applied.
    transform "TIME_HOUR"
    The partitioning transform applied to the SourceName column.
    sourceName String
    The name of the source column on which the transform is applied.
    transform ChannelPartitionFieldTransform
    The partitioning transform applied to the SourceName column.
    sourceName string
    The name of the source column on which the transform is applied.
    transform ChannelPartitionFieldTransform
    The partitioning transform applied to the SourceName column.
    source_name str
    The name of the source column on which the transform is applied.
    transform ChannelPartitionFieldTransform
    The partitioning transform applied to the SourceName column.
    sourceName String
    The name of the source column on which the transform is applied.
    transform "TIME_HOUR"
    The partitioning transform applied to the SourceName column.

    ChannelPartitionFieldTransform

    ChannelPartitionSpec

    PartitionFields List<Pulumi.AwsNative.Kinesis.Inputs.ChannelPartitionField>
    List of partition fields that define how records are partitioned when written to the destination table.
    PartitionFields []ChannelPartitionField
    List of partition fields that define how records are partitioned when written to the destination table.
    partition_fields list(object)
    List of partition fields that define how records are partitioned when written to the destination table.
    partitionFields List<ChannelPartitionField>
    List of partition fields that define how records are partitioned when written to the destination table.
    partitionFields ChannelPartitionField[]
    List of partition fields that define how records are partitioned when written to the destination table.
    partition_fields Sequence[ChannelPartitionField]
    List of partition fields that define how records are partitioned when written to the destination table.
    partitionFields List<Property Map>
    List of partition fields that define how records are partitioned when written to the destination table.

    ChannelS3DestinationConfiguration

    StorageConfiguration Pulumi.AwsNative.Kinesis.Inputs.ChannelS3StorageConfiguration
    S3 storage configuration including the destination bucket, output key template, storage class, and compression type.
    DataFreshnessInSeconds int
    The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.
    DeadLetterQueueS3Configuration Pulumi.AwsNative.Kinesis.Inputs.ChannelDeadLetterQueueS3Configuration
    Optional dead-letter queue (DLQ) configuration for records that cannot be delivered to the destination. When omitted, the service auto-fills using the storage BucketARN with an error prefix.
    StorageConfiguration ChannelS3StorageConfiguration
    S3 storage configuration including the destination bucket, output key template, storage class, and compression type.
    DataFreshnessInSeconds int
    The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.
    DeadLetterQueueS3Configuration ChannelDeadLetterQueueS3Configuration
    Optional dead-letter queue (DLQ) configuration for records that cannot be delivered to the destination. When omitted, the service auto-fills using the storage BucketARN with an error prefix.
    storage_configuration object
    S3 storage configuration including the destination bucket, output key template, storage class, and compression type.
    data_freshness_in_seconds number
    The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.
    dead_letter_queue_s3_configuration object
    Optional dead-letter queue (DLQ) configuration for records that cannot be delivered to the destination. When omitted, the service auto-fills using the storage BucketARN with an error prefix.
    storageConfiguration ChannelS3StorageConfiguration
    S3 storage configuration including the destination bucket, output key template, storage class, and compression type.
    dataFreshnessInSeconds Integer
    The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.
    deadLetterQueueS3Configuration ChannelDeadLetterQueueS3Configuration
    Optional dead-letter queue (DLQ) configuration for records that cannot be delivered to the destination. When omitted, the service auto-fills using the storage BucketARN with an error prefix.
    storageConfiguration ChannelS3StorageConfiguration
    S3 storage configuration including the destination bucket, output key template, storage class, and compression type.
    dataFreshnessInSeconds number
    The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.
    deadLetterQueueS3Configuration ChannelDeadLetterQueueS3Configuration
    Optional dead-letter queue (DLQ) configuration for records that cannot be delivered to the destination. When omitted, the service auto-fills using the storage BucketARN with an error prefix.
    storage_configuration ChannelS3StorageConfiguration
    S3 storage configuration including the destination bucket, output key template, storage class, and compression type.
    data_freshness_in_seconds int
    The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.
    dead_letter_queue_s3_configuration ChannelDeadLetterQueueS3Configuration
    Optional dead-letter queue (DLQ) configuration for records that cannot be delivered to the destination. When omitted, the service auto-fills using the storage BucketARN with an error prefix.
    storageConfiguration Property Map
    S3 storage configuration including the destination bucket, output key template, storage class, and compression type.
    dataFreshnessInSeconds Number
    The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.
    deadLetterQueueS3Configuration Property Map
    Optional dead-letter queue (DLQ) configuration for records that cannot be delivered to the destination. When omitted, the service auto-fills using the storage BucketARN with an error prefix.

    ChannelS3StorageConfiguration

    BucketArn string
    The ARN of the S3 bucket for record delivery. Different channels can deliver to the same bucket. Buckets can be cross-account but must be in the same region as the channel.
    CompressionType Pulumi.AwsNative.Kinesis.ChannelS3StorageConfigurationCompressionType
    The compression algorithm applied to delivered objects.
    ExpectedBucketOwner string
    The AWS account ID of the expected owner of the destination S3 bucket. Used to verify bucket ownership before delivery.
    OutputKeyTemplate string
    Optional template for the S3 object key path. Supports placeholders in the form !{name}: !{channel-name}, !{channel-id}, !{stream-name}, !{yyyy}, !{yy}, !{MM}, !{dd}, !{HH}, !{mm}, and !{extension} (a literal file extension can be supplied as !{extension:.json.gz}). When omitted, the service uses the default 'kinesis-channel/!{channel-name}/!{channel-id}/!{yyyy}/!{MM}/!{dd}/!{HH}/!{channel-name}-!{channel-id}-!{yyyy}-!{MM}-!{dd}-!{HH}-!{mm}!{extension}'.
    StorageClass Pulumi.AwsNative.Kinesis.ChannelS3StorageConfigurationStorageClass
    The S3 storage class for delivered objects.
    BucketArn string
    The ARN of the S3 bucket for record delivery. Different channels can deliver to the same bucket. Buckets can be cross-account but must be in the same region as the channel.
    CompressionType ChannelS3StorageConfigurationCompressionType
    The compression algorithm applied to delivered objects.
    ExpectedBucketOwner string
    The AWS account ID of the expected owner of the destination S3 bucket. Used to verify bucket ownership before delivery.
    OutputKeyTemplate string
    Optional template for the S3 object key path. Supports placeholders in the form !{name}: !{channel-name}, !{channel-id}, !{stream-name}, !{yyyy}, !{yy}, !{MM}, !{dd}, !{HH}, !{mm}, and !{extension} (a literal file extension can be supplied as !{extension:.json.gz}). When omitted, the service uses the default 'kinesis-channel/!{channel-name}/!{channel-id}/!{yyyy}/!{MM}/!{dd}/!{HH}/!{channel-name}-!{channel-id}-!{yyyy}-!{MM}-!{dd}-!{HH}-!{mm}!{extension}'.
    StorageClass ChannelS3StorageConfigurationStorageClass
    The S3 storage class for delivered objects.
    bucket_arn string
    The ARN of the S3 bucket for record delivery. Different channels can deliver to the same bucket. Buckets can be cross-account but must be in the same region as the channel.
    compression_type "NONE" | "GZIP" | "ZSTD"
    The compression algorithm applied to delivered objects.
    expected_bucket_owner string
    The AWS account ID of the expected owner of the destination S3 bucket. Used to verify bucket ownership before delivery.
    output_key_template string
    Optional template for the S3 object key path. Supports placeholders in the form !{name}: !{channel-name}, !{channel-id}, !{stream-name}, !{yyyy}, !{yy}, !{MM}, !{dd}, !{HH}, !{mm}, and !{extension} (a literal file extension can be supplied as !{extension:.json.gz}). When omitted, the service uses the default 'kinesis-channel/!{channel-name}/!{channel-id}/!{yyyy}/!{MM}/!{dd}/!{HH}/!{channel-name}-!{channel-id}-!{yyyy}-!{MM}-!{dd}-!{HH}-!{mm}!{extension}'.
    storage_class "STANDARD" | "INTELLIGENT_TIERING" | "GLACIER_IR"
    The S3 storage class for delivered objects.
    bucketArn String
    The ARN of the S3 bucket for record delivery. Different channels can deliver to the same bucket. Buckets can be cross-account but must be in the same region as the channel.
    compressionType ChannelS3StorageConfigurationCompressionType
    The compression algorithm applied to delivered objects.
    expectedBucketOwner String
    The AWS account ID of the expected owner of the destination S3 bucket. Used to verify bucket ownership before delivery.
    outputKeyTemplate String
    Optional template for the S3 object key path. Supports placeholders in the form !{name}: !{channel-name}, !{channel-id}, !{stream-name}, !{yyyy}, !{yy}, !{MM}, !{dd}, !{HH}, !{mm}, and !{extension} (a literal file extension can be supplied as !{extension:.json.gz}). When omitted, the service uses the default 'kinesis-channel/!{channel-name}/!{channel-id}/!{yyyy}/!{MM}/!{dd}/!{HH}/!{channel-name}-!{channel-id}-!{yyyy}-!{MM}-!{dd}-!{HH}-!{mm}!{extension}'.
    storageClass ChannelS3StorageConfigurationStorageClass
    The S3 storage class for delivered objects.
    bucketArn string
    The ARN of the S3 bucket for record delivery. Different channels can deliver to the same bucket. Buckets can be cross-account but must be in the same region as the channel.
    compressionType ChannelS3StorageConfigurationCompressionType
    The compression algorithm applied to delivered objects.
    expectedBucketOwner string
    The AWS account ID of the expected owner of the destination S3 bucket. Used to verify bucket ownership before delivery.
    outputKeyTemplate string
    Optional template for the S3 object key path. Supports placeholders in the form !{name}: !{channel-name}, !{channel-id}, !{stream-name}, !{yyyy}, !{yy}, !{MM}, !{dd}, !{HH}, !{mm}, and !{extension} (a literal file extension can be supplied as !{extension:.json.gz}). When omitted, the service uses the default 'kinesis-channel/!{channel-name}/!{channel-id}/!{yyyy}/!{MM}/!{dd}/!{HH}/!{channel-name}-!{channel-id}-!{yyyy}-!{MM}-!{dd}-!{HH}-!{mm}!{extension}'.
    storageClass ChannelS3StorageConfigurationStorageClass
    The S3 storage class for delivered objects.
    bucket_arn str
    The ARN of the S3 bucket for record delivery. Different channels can deliver to the same bucket. Buckets can be cross-account but must be in the same region as the channel.
    compression_type ChannelS3StorageConfigurationCompressionType
    The compression algorithm applied to delivered objects.
    expected_bucket_owner str
    The AWS account ID of the expected owner of the destination S3 bucket. Used to verify bucket ownership before delivery.
    output_key_template str
    Optional template for the S3 object key path. Supports placeholders in the form !{name}: !{channel-name}, !{channel-id}, !{stream-name}, !{yyyy}, !{yy}, !{MM}, !{dd}, !{HH}, !{mm}, and !{extension} (a literal file extension can be supplied as !{extension:.json.gz}). When omitted, the service uses the default 'kinesis-channel/!{channel-name}/!{channel-id}/!{yyyy}/!{MM}/!{dd}/!{HH}/!{channel-name}-!{channel-id}-!{yyyy}-!{MM}-!{dd}-!{HH}-!{mm}!{extension}'.
    storage_class ChannelS3StorageConfigurationStorageClass
    The S3 storage class for delivered objects.
    bucketArn String
    The ARN of the S3 bucket for record delivery. Different channels can deliver to the same bucket. Buckets can be cross-account but must be in the same region as the channel.
    compressionType "NONE" | "GZIP" | "ZSTD"
    The compression algorithm applied to delivered objects.
    expectedBucketOwner String
    The AWS account ID of the expected owner of the destination S3 bucket. Used to verify bucket ownership before delivery.
    outputKeyTemplate String
    Optional template for the S3 object key path. Supports placeholders in the form !{name}: !{channel-name}, !{channel-id}, !{stream-name}, !{yyyy}, !{yy}, !{MM}, !{dd}, !{HH}, !{mm}, and !{extension} (a literal file extension can be supplied as !{extension:.json.gz}). When omitted, the service uses the default 'kinesis-channel/!{channel-name}/!{channel-id}/!{yyyy}/!{MM}/!{dd}/!{HH}/!{channel-name}-!{channel-id}-!{yyyy}-!{MM}-!{dd}-!{HH}-!{mm}!{extension}'.
    storageClass "STANDARD" | "INTELLIGENT_TIERING" | "GLACIER_IR"
    The S3 storage class for delivered objects.

    ChannelS3StorageConfigurationCompressionType

    ChannelS3StorageConfigurationStorageClass

    ChannelS3TableConfiguration

    CompressionType Pulumi.AwsNative.Kinesis.ChannelS3TableConfigurationCompressionType
    The compression algorithm applied to objects delivered to the S3 Tables destination.
    Namespace string
    The name of the S3 Tables namespace that contains the destination table.
    TableBucketArn string
    The ARN of the S3 Tables table bucket for record delivery. Buckets can be cross-account but must be in the same region as the channel.
    TableName string
    The name of the destination S3 Tables table. The table is created for the customer if it does not yet exist.
    PartitionSpec Pulumi.AwsNative.Kinesis.Inputs.ChannelPartitionSpec
    The partition specification used by the destination Iceberg table.
    CompressionType ChannelS3TableConfigurationCompressionType
    The compression algorithm applied to objects delivered to the S3 Tables destination.
    Namespace string
    The name of the S3 Tables namespace that contains the destination table.
    TableBucketArn string
    The ARN of the S3 Tables table bucket for record delivery. Buckets can be cross-account but must be in the same region as the channel.
    TableName string
    The name of the destination S3 Tables table. The table is created for the customer if it does not yet exist.
    PartitionSpec ChannelPartitionSpec
    The partition specification used by the destination Iceberg table.
    compression_type "NONE" | "ZSTD" | "SNAPPY"
    The compression algorithm applied to objects delivered to the S3 Tables destination.
    namespace string
    The name of the S3 Tables namespace that contains the destination table.
    table_bucket_arn string
    The ARN of the S3 Tables table bucket for record delivery. Buckets can be cross-account but must be in the same region as the channel.
    table_name string
    The name of the destination S3 Tables table. The table is created for the customer if it does not yet exist.
    partition_spec object
    The partition specification used by the destination Iceberg table.
    compressionType ChannelS3TableConfigurationCompressionType
    The compression algorithm applied to objects delivered to the S3 Tables destination.
    namespace String
    The name of the S3 Tables namespace that contains the destination table.
    tableBucketArn String
    The ARN of the S3 Tables table bucket for record delivery. Buckets can be cross-account but must be in the same region as the channel.
    tableName String
    The name of the destination S3 Tables table. The table is created for the customer if it does not yet exist.
    partitionSpec ChannelPartitionSpec
    The partition specification used by the destination Iceberg table.
    compressionType ChannelS3TableConfigurationCompressionType
    The compression algorithm applied to objects delivered to the S3 Tables destination.
    namespace string
    The name of the S3 Tables namespace that contains the destination table.
    tableBucketArn string
    The ARN of the S3 Tables table bucket for record delivery. Buckets can be cross-account but must be in the same region as the channel.
    tableName string
    The name of the destination S3 Tables table. The table is created for the customer if it does not yet exist.
    partitionSpec ChannelPartitionSpec
    The partition specification used by the destination Iceberg table.
    compression_type ChannelS3TableConfigurationCompressionType
    The compression algorithm applied to objects delivered to the S3 Tables destination.
    namespace str
    The name of the S3 Tables namespace that contains the destination table.
    table_bucket_arn str
    The ARN of the S3 Tables table bucket for record delivery. Buckets can be cross-account but must be in the same region as the channel.
    table_name str
    The name of the destination S3 Tables table. The table is created for the customer if it does not yet exist.
    partition_spec ChannelPartitionSpec
    The partition specification used by the destination Iceberg table.
    compressionType "NONE" | "ZSTD" | "SNAPPY"
    The compression algorithm applied to objects delivered to the S3 Tables destination.
    namespace String
    The name of the S3 Tables namespace that contains the destination table.
    tableBucketArn String
    The ARN of the S3 Tables table bucket for record delivery. Buckets can be cross-account but must be in the same region as the channel.
    tableName String
    The name of the destination S3 Tables table. The table is created for the customer if it does not yet exist.
    partitionSpec Property Map
    The partition specification used by the destination Iceberg table.

    ChannelS3TableConfigurationCompressionType

    ChannelS3TablesDestinationConfiguration

    DeadLetterQueueS3Configuration Pulumi.AwsNative.Kinesis.Inputs.ChannelDeadLetterQueueS3Configuration
    The dead-letter queue (DLQ) configuration for records that cannot be delivered to the S3 Tables destination. Required for S3 Tables: there is no safe fallback because S3 Tables metadata writes are critical-path.
    S3TablesConfigurationList List<Pulumi.AwsNative.Kinesis.Inputs.ChannelS3TableConfiguration>
    The list of S3 Tables destinations. v1 supports a single element; the list shape allows future extensibility to fan out to multiple tables.
    DataFreshnessInSeconds int
    The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.
    DeadLetterQueueS3Configuration ChannelDeadLetterQueueS3Configuration
    The dead-letter queue (DLQ) configuration for records that cannot be delivered to the S3 Tables destination. Required for S3 Tables: there is no safe fallback because S3 Tables metadata writes are critical-path.
    S3TablesConfigurationList []ChannelS3TableConfiguration
    The list of S3 Tables destinations. v1 supports a single element; the list shape allows future extensibility to fan out to multiple tables.
    DataFreshnessInSeconds int
    The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.
    dead_letter_queue_s3_configuration object
    The dead-letter queue (DLQ) configuration for records that cannot be delivered to the S3 Tables destination. Required for S3 Tables: there is no safe fallback because S3 Tables metadata writes are critical-path.
    s3_tables_configuration_list list(object)
    The list of S3 Tables destinations. v1 supports a single element; the list shape allows future extensibility to fan out to multiple tables.
    data_freshness_in_seconds number
    The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.
    deadLetterQueueS3Configuration ChannelDeadLetterQueueS3Configuration
    The dead-letter queue (DLQ) configuration for records that cannot be delivered to the S3 Tables destination. Required for S3 Tables: there is no safe fallback because S3 Tables metadata writes are critical-path.
    s3TablesConfigurationList List<ChannelS3TableConfiguration>
    The list of S3 Tables destinations. v1 supports a single element; the list shape allows future extensibility to fan out to multiple tables.
    dataFreshnessInSeconds Integer
    The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.
    deadLetterQueueS3Configuration ChannelDeadLetterQueueS3Configuration
    The dead-letter queue (DLQ) configuration for records that cannot be delivered to the S3 Tables destination. Required for S3 Tables: there is no safe fallback because S3 Tables metadata writes are critical-path.
    s3TablesConfigurationList ChannelS3TableConfiguration[]
    The list of S3 Tables destinations. v1 supports a single element; the list shape allows future extensibility to fan out to multiple tables.
    dataFreshnessInSeconds number
    The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.
    dead_letter_queue_s3_configuration ChannelDeadLetterQueueS3Configuration
    The dead-letter queue (DLQ) configuration for records that cannot be delivered to the S3 Tables destination. Required for S3 Tables: there is no safe fallback because S3 Tables metadata writes are critical-path.
    s3_tables_configuration_list Sequence[ChannelS3TableConfiguration]
    The list of S3 Tables destinations. v1 supports a single element; the list shape allows future extensibility to fan out to multiple tables.
    data_freshness_in_seconds int
    The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.
    deadLetterQueueS3Configuration Property Map
    The dead-letter queue (DLQ) configuration for records that cannot be delivered to the S3 Tables destination. Required for S3 Tables: there is no safe fallback because S3 Tables metadata writes are critical-path.
    s3TablesConfigurationList List<Property Map>
    The list of S3 Tables destinations. v1 supports a single element; the list shape allows future extensibility to fan out to multiple tables.
    dataFreshnessInSeconds Number
    The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.

    ChannelStatus

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

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

    Viewing docs for AWS Cloud Control v1.81.0
    published on Monday, Sep 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial