Class CfnChannel

Resource Type definition for AWS::MSK::Channel.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnChannel
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.MSK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnChannel : CfnResource, IInspectable, IChannelRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnChannel Inherits CfnResource Implements IInspectable, IChannelRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html

CloudformationResource: AWS::MSK::Channel

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.MSK;

             var cfnChannel = new CfnChannel(this, "MyCfnChannel", new CfnChannelProps {
                 ChannelName = "channelName",
                 TopicConfigurationList = new [] { new TopicConfigurationProperty {
                     RecordConverter = new RecordConverterProperty {
                         ValueConverter = "valueConverter"
                     },
                     TopicArn = "topicArn",

                     // the properties below are optional
                     RecordSchema = new RecordSchemaProperty {
                         GsrArn = "gsrArn"
                     }
                 } },

                 // the properties below are optional
                 ClusterArn = "clusterArn",
                 EncryptionConfiguration = new EncryptionConfigurationProperty {
                     KmsKeyArn = "kmsKeyArn"
                 },
                 IcebergDestinationConfiguration = new IcebergDestinationConfigurationProperty {
                     AppendOnly = false,
                     DeadLetterQueueS3 = new DeadLetterQueueS3Property {
                         BucketArn = "bucketArn",
                         ErrorOutputPrefix = "errorOutputPrefix",

                         // the properties below are optional
                         ExpectedBucketOwner = "expectedBucketOwner"
                     },
                     DestinationTableList = new [] { new DestinationTableProperty {
                         DestinationDatabaseName = "destinationDatabaseName",
                         DestinationTableName = "destinationTableName",

                         // the properties below are optional
                         PartitionSpec = new PartitionSpecProperty {
                             PartitionStrategy = "partitionStrategy",

                             // the properties below are optional
                             SourceList = new [] { new PartitionSourceProperty {
                                 SourceName = "sourceName"
                             } }
                         }
                     } },
                     SchemaEvolution = new SchemaEvolutionProperty {
                         EnableSchemaEvolution = false
                     },
                     ServiceExecutionRoleArn = "serviceExecutionRoleArn",
                     TableCreation = new TableCreationProperty {
                         EnableTableCreation = false
                     },

                     // the properties below are optional
                     Catalog = new CatalogProperty {
                         CatalogArn = "catalogArn",
                         WarehouseLocation = "warehouseLocation"
                     },
                     CompressionType = "compressionType",
                     DataFreshnessInSeconds = 123
                 },
                 LoggingInfo = new ChannelLoggingInfoProperty {
                     CloudWatchLogs = new CloudWatchLogsLogDestinationProperty {
                         Enabled = false,

                         // the properties below are optional
                         LogGroup = "logGroup"
                     },
                     Firehose = new FirehoseLogDestinationProperty {
                         Enabled = false,

                         // the properties below are optional
                         DeliveryStream = "deliveryStream"
                     },
                     S3 = new S3LogDestinationProperty {
                         Enabled = false,

                         // the properties below are optional
                         Bucket = "bucket",
                         Prefix = "prefix"
                     }
                 },
                 S3DestinationConfiguration = new S3DestinationConfigurationProperty {
                     DeadLetterQueueS3 = new DeadLetterQueueS3Property {
                         BucketArn = "bucketArn",
                         ErrorOutputPrefix = "errorOutputPrefix",

                         // the properties below are optional
                         ExpectedBucketOwner = "expectedBucketOwner"
                     },
                     ServiceExecutionRoleArn = "serviceExecutionRoleArn",
                     Storage = new S3StorageProperty {
                         BucketArn = "bucketArn",
                         CompressionType = "compressionType",
                         StorageClass = "storageClass",

                         // the properties below are optional
                         ExpectedBucketOwner = "expectedBucketOwner",
                         OutputKeyTemplate = "outputKeyTemplate",
                         OutputPrefix = "outputPrefix"
                     },

                     // the properties below are optional
                     DataFreshnessInSeconds = 123
                 },
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

Synopsis

Constructors

CfnChannel(Construct, string, ICfnChannelProps)

Create a new AWS::MSK::Channel.

Properties

AttrChannelArn

The Amazon Resource Name (ARN) that uniquely identifies the channel.
AttrStateInfo

Includes information about the channel state.
AttrStatus

Status of a channel resource.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

Resource Type definition for AWS::MSK::Channel.
CfnPropertyNames

Resource Type definition for AWS::MSK::Channel.
ChannelName

Name of the channel.
ChannelRef

A reference to a Channel resource.
ClusterArn

The Amazon Resource Name (ARN) of the cluster.
EncryptionConfiguration

Encryption configuration.
IcebergDestinationConfiguration

Iceberg destination configuration.
LoggingInfo

Log configuration details for Channel.
S3DestinationConfiguration

S3 destination configuration.
Tags

Tags attached to the channel.
TopicConfigurationList

Topic configuration.

Methods

ArnForChannel(IChannelRef)

Resource Type definition for AWS::MSK::Channel.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnChannel(object)

Checks whether the given object is a CfnChannel.
RenderProperties(IDictionary<string, object>)

Resource Type definition for AWS::MSK::Channel.

Constructors

CfnChannel(Construct, string, ICfnChannelProps)

Create a new AWS::MSK::Channel.

public CfnChannel(Construct scope, string id, ICfnChannelProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnChannelProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html

CloudformationResource: AWS::MSK::Channel

ExampleMetadata: fixture=_generated

Properties

AttrChannelArn

The Amazon Resource Name (ARN) that uniquely identifies the channel.

public virtual string AttrChannelArn { get; }
Property Value

string

Remarks

CloudformationAttribute: ChannelArn

AttrStateInfo

Includes information about the channel state.

public virtual IResolvable AttrStateInfo { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: StateInfo

AttrStatus

Status of a channel resource.

public virtual string AttrStatus { get; }
Property Value

string

Remarks

CloudformationAttribute: Status

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html

CloudformationResource: AWS::MSK::Channel

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html

CloudformationResource: AWS::MSK::Channel

ExampleMetadata: fixture=_generated

CfnProperties

Resource Type definition for AWS::MSK::Channel.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html

CloudformationResource: AWS::MSK::Channel

ExampleMetadata: fixture=_generated

CfnPropertyNames

Resource Type definition for AWS::MSK::Channel.

protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value

IDictionary<string, string>

Overrides
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html

CloudformationResource: AWS::MSK::Channel

ExampleMetadata: fixture=_generated

ChannelName

Name of the channel.

public virtual string ChannelName { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html

CloudformationResource: AWS::MSK::Channel

ExampleMetadata: fixture=_generated

ChannelRef

A reference to a Channel resource.

public virtual IChannelReference ChannelRef { get; }
Property Value

IChannelReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html

CloudformationResource: AWS::MSK::Channel

ExampleMetadata: fixture=_generated

ClusterArn

The Amazon Resource Name (ARN) of the cluster.

public virtual string? ClusterArn { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html

CloudformationResource: AWS::MSK::Channel

ExampleMetadata: fixture=_generated

EncryptionConfiguration

Encryption configuration.

public virtual object? EncryptionConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnChannel.IEncryptionConfigurationProperty

IcebergDestinationConfiguration

Iceberg destination configuration.

public virtual object? IcebergDestinationConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnChannel.IIcebergDestinationConfigurationProperty

LoggingInfo

Log configuration details for Channel.

public virtual object? LoggingInfo { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnChannel.IChannelLoggingInfoProperty

S3DestinationConfiguration

S3 destination configuration.

public virtual object? S3DestinationConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnChannel.IS3DestinationConfigurationProperty

Tags

Tags attached to the channel.

public virtual IDictionary<string, string>? Tags { get; set; }
Property Value

IDictionary<string, string>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html

CloudformationResource: AWS::MSK::Channel

ExampleMetadata: fixture=_generated

TopicConfigurationList

Topic configuration.

public virtual object TopicConfigurationList { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnChannel.ITopicConfigurationProperty)[]

Methods

ArnForChannel(IChannelRef)

Resource Type definition for AWS::MSK::Channel.

public static string ArnForChannel(IChannelRef resource)
Parameters
resource IChannelRef
Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html

CloudformationResource: AWS::MSK::Channel

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.MSK;

             var cfnChannel = new CfnChannel(this, "MyCfnChannel", new CfnChannelProps {
                 ChannelName = "channelName",
                 TopicConfigurationList = new [] { new TopicConfigurationProperty {
                     RecordConverter = new RecordConverterProperty {
                         ValueConverter = "valueConverter"
                     },
                     TopicArn = "topicArn",

                     // the properties below are optional
                     RecordSchema = new RecordSchemaProperty {
                         GsrArn = "gsrArn"
                     }
                 } },

                 // the properties below are optional
                 ClusterArn = "clusterArn",
                 EncryptionConfiguration = new EncryptionConfigurationProperty {
                     KmsKeyArn = "kmsKeyArn"
                 },
                 IcebergDestinationConfiguration = new IcebergDestinationConfigurationProperty {
                     AppendOnly = false,
                     DeadLetterQueueS3 = new DeadLetterQueueS3Property {
                         BucketArn = "bucketArn",
                         ErrorOutputPrefix = "errorOutputPrefix",

                         // the properties below are optional
                         ExpectedBucketOwner = "expectedBucketOwner"
                     },
                     DestinationTableList = new [] { new DestinationTableProperty {
                         DestinationDatabaseName = "destinationDatabaseName",
                         DestinationTableName = "destinationTableName",

                         // the properties below are optional
                         PartitionSpec = new PartitionSpecProperty {
                             PartitionStrategy = "partitionStrategy",

                             // the properties below are optional
                             SourceList = new [] { new PartitionSourceProperty {
                                 SourceName = "sourceName"
                             } }
                         }
                     } },
                     SchemaEvolution = new SchemaEvolutionProperty {
                         EnableSchemaEvolution = false
                     },
                     ServiceExecutionRoleArn = "serviceExecutionRoleArn",
                     TableCreation = new TableCreationProperty {
                         EnableTableCreation = false
                     },

                     // the properties below are optional
                     Catalog = new CatalogProperty {
                         CatalogArn = "catalogArn",
                         WarehouseLocation = "warehouseLocation"
                     },
                     CompressionType = "compressionType",
                     DataFreshnessInSeconds = 123
                 },
                 LoggingInfo = new ChannelLoggingInfoProperty {
                     CloudWatchLogs = new CloudWatchLogsLogDestinationProperty {
                         Enabled = false,

                         // the properties below are optional
                         LogGroup = "logGroup"
                     },
                     Firehose = new FirehoseLogDestinationProperty {
                         Enabled = false,

                         // the properties below are optional
                         DeliveryStream = "deliveryStream"
                     },
                     S3 = new S3LogDestinationProperty {
                         Enabled = false,

                         // the properties below are optional
                         Bucket = "bucket",
                         Prefix = "prefix"
                     }
                 },
                 S3DestinationConfiguration = new S3DestinationConfigurationProperty {
                     DeadLetterQueueS3 = new DeadLetterQueueS3Property {
                         BucketArn = "bucketArn",
                         ErrorOutputPrefix = "errorOutputPrefix",

                         // the properties below are optional
                         ExpectedBucketOwner = "expectedBucketOwner"
                     },
                     ServiceExecutionRoleArn = "serviceExecutionRoleArn",
                     Storage = new S3StorageProperty {
                         BucketArn = "bucketArn",
                         CompressionType = "compressionType",
                         StorageClass = "storageClass",

                         // the properties below are optional
                         ExpectedBucketOwner = "expectedBucketOwner",
                         OutputKeyTemplate = "outputKeyTemplate",
                         OutputPrefix = "outputPrefix"
                     },

                     // the properties below are optional
                     DataFreshnessInSeconds = 123
                 },
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html

CloudformationResource: AWS::MSK::Channel

ExampleMetadata: fixture=_generated

IsCfnChannel(object)

Checks whether the given object is a CfnChannel.

public static bool IsCfnChannel(object x)
Parameters
x object
Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html

CloudformationResource: AWS::MSK::Channel

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Resource Type definition for AWS::MSK::Channel.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html

CloudformationResource: AWS::MSK::Channel

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable