Show / Hide Table of Contents

Class CfnChannel.S3TableConfigurationProperty

An S3 Tables destination including its table bucket, namespace, table name, and partition spec.

Inheritance
object
CfnChannel.S3TableConfigurationProperty
Implements
CfnChannel.IS3TableConfigurationProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.Kinesis
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnChannel.S3TableConfigurationProperty : CfnChannel.IS3TableConfigurationProperty
Syntax (vb)
Public Class CfnChannel.S3TableConfigurationProperty Implements CfnChannel.IS3TableConfigurationProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3tableconfiguration.html

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.Kinesis;

             var s3TableConfigurationProperty = new S3TableConfigurationProperty {
                 CompressionType = "compressionType",
                 Namespace = "namespace",
                 TableBucketArn = "tableBucketArn",
                 TableName = "tableName",

                 // the properties below are optional
                 PartitionSpec = new PartitionSpecProperty {
                     PartitionFields = new [] { new PartitionFieldProperty {
                         SourceName = "sourceName",
                         Transform = "transform"
                     } }
                 }
             };

Synopsis

Constructors

S3TableConfigurationProperty()

An S3 Tables destination including its table bucket, namespace, table name, and partition spec.

Properties

CompressionType

The compression algorithm applied to objects delivered to the S3 Tables destination.

Namespace

The name of the S3 Tables namespace that contains the destination table.

PartitionSpec

Partitioning specification for the destination Iceberg table.

TableBucketArn

The ARN of the S3 Tables table bucket for record delivery.

TableName

The name of the destination S3 Tables table.

Constructors

S3TableConfigurationProperty()

An S3 Tables destination including its table bucket, namespace, table name, and partition spec.

public S3TableConfigurationProperty()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3tableconfiguration.html

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.Kinesis;

             var s3TableConfigurationProperty = new S3TableConfigurationProperty {
                 CompressionType = "compressionType",
                 Namespace = "namespace",
                 TableBucketArn = "tableBucketArn",
                 TableName = "tableName",

                 // the properties below are optional
                 PartitionSpec = new PartitionSpecProperty {
                     PartitionFields = new [] { new PartitionFieldProperty {
                         SourceName = "sourceName",
                         Transform = "transform"
                     } }
                 }
             };

Properties

CompressionType

The compression algorithm applied to objects delivered to the S3 Tables destination.

public string CompressionType { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3tableconfiguration.html#cfn-kinesis-channel-s3tableconfiguration-compressiontype

Namespace

The name of the S3 Tables namespace that contains the destination table.

public string Namespace { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3tableconfiguration.html#cfn-kinesis-channel-s3tableconfiguration-namespace

PartitionSpec

Partitioning specification for the destination Iceberg table.

public object? PartitionSpec { get; set; }
Property Value

object

Remarks

Follows the S3 Tables / Iceberg PartitionSpec format.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3tableconfiguration.html#cfn-kinesis-channel-s3tableconfiguration-partitionspec

Type union: either IResolvable or CfnChannel.IPartitionSpecProperty

TableBucketArn

The ARN of the S3 Tables table bucket for record delivery.

public string TableBucketArn { get; set; }
Property Value

string

Remarks

Buckets can be cross-account but must be in the same region as the channel.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3tableconfiguration.html#cfn-kinesis-channel-s3tableconfiguration-tablebucketarn

TableName

The name of the destination S3 Tables table.

public string TableName { get; set; }
Property Value

string

Remarks

The table is created for the customer if it does not yet exist.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3tableconfiguration.html#cfn-kinesis-channel-s3tableconfiguration-tablename

Implements

CfnChannel.IS3TableConfigurationProperty
Back to top Generated by DocFX