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

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

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

aws-native.msk.getChannel

aws-native logo

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

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

    Resource Type definition for AWS::MSK::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?: InvokeOptions): 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[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)
public static Output<GetChannelResult> getChannel(GetChannelArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ChannelArn string
    The Amazon Resource Name (ARN) that uniquely identifies the channel
    ChannelArn string
    The Amazon Resource Name (ARN) that uniquely identifies the channel
    channel_arn string
    The Amazon Resource Name (ARN) that uniquely identifies the channel
    channelArn String
    The Amazon Resource Name (ARN) that uniquely identifies the channel
    channelArn string
    The Amazon Resource Name (ARN) that uniquely identifies the channel
    channel_arn str
    The Amazon Resource Name (ARN) that uniquely identifies the channel
    channelArn String
    The Amazon Resource Name (ARN) that uniquely identifies the channel

    getChannel Result

    The following output properties are available:

    Supporting Types

    ChannelCatalog

    CatalogArn string
    The ARN of the catalog
    WarehouseLocation string
    The warehouse location
    CatalogArn string
    The ARN of the catalog
    WarehouseLocation string
    The warehouse location
    catalog_arn string
    The ARN of the catalog
    warehouse_location string
    The warehouse location
    catalogArn String
    The ARN of the catalog
    warehouseLocation String
    The warehouse location
    catalogArn string
    The ARN of the catalog
    warehouseLocation string
    The warehouse location
    catalog_arn str
    The ARN of the catalog
    warehouse_location str
    The warehouse location
    catalogArn String
    The ARN of the catalog
    warehouseLocation String
    The warehouse location

    ChannelDeadLetterQueueS3

    BucketArn string
    The ARN of the S3 bucket
    ErrorOutputPrefix string
    The error output prefix
    ExpectedBucketOwner string
    Optional 12-digit AWS account ID expected to own the dead-letter S3 bucket
    BucketArn string
    The ARN of the S3 bucket
    ErrorOutputPrefix string
    The error output prefix
    ExpectedBucketOwner string
    Optional 12-digit AWS account ID expected to own the dead-letter S3 bucket
    bucket_arn string
    The ARN of the S3 bucket
    error_output_prefix string
    The error output prefix
    expected_bucket_owner string
    Optional 12-digit AWS account ID expected to own the dead-letter S3 bucket
    bucketArn String
    The ARN of the S3 bucket
    errorOutputPrefix String
    The error output prefix
    expectedBucketOwner String
    Optional 12-digit AWS account ID expected to own the dead-letter S3 bucket
    bucketArn string
    The ARN of the S3 bucket
    errorOutputPrefix string
    The error output prefix
    expectedBucketOwner string
    Optional 12-digit AWS account ID expected to own the dead-letter S3 bucket
    bucket_arn str
    The ARN of the S3 bucket
    error_output_prefix str
    The error output prefix
    expected_bucket_owner str
    Optional 12-digit AWS account ID expected to own the dead-letter S3 bucket
    bucketArn String
    The ARN of the S3 bucket
    errorOutputPrefix String
    The error output prefix
    expectedBucketOwner String
    Optional 12-digit AWS account ID expected to own the dead-letter S3 bucket

    ChannelDestinationTable

    DestinationDatabaseName string
    The destination database name
    DestinationTableName string
    The destination table name
    PartitionSpec Pulumi.AwsNative.Msk.Inputs.ChannelPartitionSpec
    DestinationDatabaseName string
    The destination database name
    DestinationTableName string
    The destination table name
    PartitionSpec ChannelPartitionSpec
    destination_database_name string
    The destination database name
    destination_table_name string
    The destination table name
    partition_spec object
    destinationDatabaseName String
    The destination database name
    destinationTableName String
    The destination table name
    partitionSpec ChannelPartitionSpec
    destinationDatabaseName string
    The destination database name
    destinationTableName string
    The destination table name
    partitionSpec ChannelPartitionSpec
    destination_database_name str
    The destination database name
    destination_table_name str
    The destination table name
    partition_spec ChannelPartitionSpec
    destinationDatabaseName String
    The destination database name
    destinationTableName String
    The destination table name
    partitionSpec Property Map

    ChannelIcebergCompressionType

    ChannelIcebergDestinationConfiguration

    append_only bool
    Append only mode
    dead_letter_queue_s3 object
    destination_table_list list(object)
    List of destination tables
    schema_evolution object
    service_execution_role_arn string
    The Amazon Resource Name (ARN) of an IAM role used by MSK to access the table
    table_creation object
    catalog object
    compression_type "ZSTD" | "SNAPPY"
    data_freshness_in_seconds number
    Data freshness in seconds
    appendOnly Boolean
    Append only mode
    deadLetterQueueS3 Property Map
    destinationTableList List<Property Map>
    List of destination tables
    schemaEvolution Property Map
    serviceExecutionRoleArn String
    The Amazon Resource Name (ARN) of an IAM role used by MSK to access the table
    tableCreation Property Map
    catalog Property Map
    compressionType "ZSTD" | "SNAPPY"
    dataFreshnessInSeconds Number
    Data freshness in seconds

    ChannelPartitionSource

    SourceName string
    Source name
    SourceName string
    Source name
    source_name string
    Source name
    sourceName String
    Source name
    sourceName string
    Source name
    source_name str
    Source name
    sourceName String
    Source name

    ChannelPartitionSpec

    ChannelPartitionStrategy

    ChannelS3CompressionType

    ChannelS3DestinationConfiguration

    DeadLetterQueueS3 ChannelDeadLetterQueueS3
    ServiceExecutionRoleArn string
    The Amazon Resource Name (ARN) of an IAM role used by MSK to access S3
    Storage ChannelS3Storage
    DataFreshnessInSeconds int
    Data freshness in seconds
    dead_letter_queue_s3 object
    service_execution_role_arn string
    The Amazon Resource Name (ARN) of an IAM role used by MSK to access S3
    storage object
    data_freshness_in_seconds number
    Data freshness in seconds
    deadLetterQueueS3 ChannelDeadLetterQueueS3
    serviceExecutionRoleArn String
    The Amazon Resource Name (ARN) of an IAM role used by MSK to access S3
    storage ChannelS3Storage
    dataFreshnessInSeconds Integer
    Data freshness in seconds
    deadLetterQueueS3 ChannelDeadLetterQueueS3
    serviceExecutionRoleArn string
    The Amazon Resource Name (ARN) of an IAM role used by MSK to access S3
    storage ChannelS3Storage
    dataFreshnessInSeconds number
    Data freshness in seconds
    dead_letter_queue_s3 ChannelDeadLetterQueueS3
    service_execution_role_arn str
    The Amazon Resource Name (ARN) of an IAM role used by MSK to access S3
    storage ChannelS3Storage
    data_freshness_in_seconds int
    Data freshness in seconds
    deadLetterQueueS3 Property Map
    serviceExecutionRoleArn String
    The Amazon Resource Name (ARN) of an IAM role used by MSK to access S3
    storage Property Map
    dataFreshnessInSeconds Number
    Data freshness in seconds

    ChannelS3Storage

    BucketArn string
    ARN of the S3 bucket
    CompressionType Pulumi.AwsNative.Msk.ChannelS3CompressionType
    StorageClass Pulumi.AwsNative.Msk.ChannelS3StorageClass
    ExpectedBucketOwner string
    Optional 12-digit AWS account ID expected to own the S3 bucket
    OutputKeyTemplate string
    Template for S3 key for output objects, used for partitioning
    OutputPrefix string
    Optional prefix for output objects
    BucketArn string
    ARN of the S3 bucket
    CompressionType ChannelS3CompressionType
    StorageClass ChannelS3StorageClass
    ExpectedBucketOwner string
    Optional 12-digit AWS account ID expected to own the S3 bucket
    OutputKeyTemplate string
    Template for S3 key for output objects, used for partitioning
    OutputPrefix string
    Optional prefix for output objects
    bucket_arn string
    ARN of the S3 bucket
    compression_type "NONE" | "GZIP" | "ZSTD"
    storage_class "STANDARD" | "INTELLIGENT_TIERING" | "GLACIER_IR"
    expected_bucket_owner string
    Optional 12-digit AWS account ID expected to own the S3 bucket
    output_key_template string
    Template for S3 key for output objects, used for partitioning
    output_prefix string
    Optional prefix for output objects
    bucketArn String
    ARN of the S3 bucket
    compressionType ChannelS3CompressionType
    storageClass ChannelS3StorageClass
    expectedBucketOwner String
    Optional 12-digit AWS account ID expected to own the S3 bucket
    outputKeyTemplate String
    Template for S3 key for output objects, used for partitioning
    outputPrefix String
    Optional prefix for output objects
    bucketArn string
    ARN of the S3 bucket
    compressionType ChannelS3CompressionType
    storageClass ChannelS3StorageClass
    expectedBucketOwner string
    Optional 12-digit AWS account ID expected to own the S3 bucket
    outputKeyTemplate string
    Template for S3 key for output objects, used for partitioning
    outputPrefix string
    Optional prefix for output objects
    bucket_arn str
    ARN of the S3 bucket
    compression_type ChannelS3CompressionType
    storage_class ChannelS3StorageClass
    expected_bucket_owner str
    Optional 12-digit AWS account ID expected to own the S3 bucket
    output_key_template str
    Template for S3 key for output objects, used for partitioning
    output_prefix str
    Optional prefix for output objects
    bucketArn String
    ARN of the S3 bucket
    compressionType "NONE" | "GZIP" | "ZSTD"
    storageClass "STANDARD" | "INTELLIGENT_TIERING" | "GLACIER_IR"
    expectedBucketOwner String
    Optional 12-digit AWS account ID expected to own the S3 bucket
    outputKeyTemplate String
    Template for S3 key for output objects, used for partitioning
    outputPrefix String
    Optional prefix for output objects

    ChannelS3StorageClass

    ChannelSchemaEvolution

    EnableSchemaEvolution bool
    Whether schema evolution is enabled
    EnableSchemaEvolution bool
    Whether schema evolution is enabled
    enable_schema_evolution bool
    Whether schema evolution is enabled
    enableSchemaEvolution Boolean
    Whether schema evolution is enabled
    enableSchemaEvolution boolean
    Whether schema evolution is enabled
    enable_schema_evolution bool
    Whether schema evolution is enabled
    enableSchemaEvolution Boolean
    Whether schema evolution is enabled

    ChannelStateInfo

    Code string
    Code for channel state
    Message string
    Message for channel state
    Code string
    Code for channel state
    Message string
    Message for channel state
    code string
    Code for channel state
    message string
    Message for channel state
    code String
    Code for channel state
    message String
    Message for channel state
    code string
    Code for channel state
    message string
    Message for channel state
    code str
    Code for channel state
    message str
    Message for channel state
    code String
    Code for channel state
    message String
    Message for channel state

    ChannelStatus

    ChannelTableCreation

    EnableTableCreation bool
    Whether table creation is enabled
    EnableTableCreation bool
    Whether table creation is enabled
    enable_table_creation bool
    Whether table creation is enabled
    enableTableCreation Boolean
    Whether table creation is enabled
    enableTableCreation boolean
    Whether table creation is enabled
    enable_table_creation bool
    Whether table creation is enabled
    enableTableCreation Boolean
    Whether table creation is enabled

    Package Details

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

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

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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial