Class CfnDeliveryStream.IcebergDestinationConfigurationProperty

Specifies the destination configure settings for Apache Iceberg Table.

Inheritance

object

CfnDeliveryStream.IcebergDestinationConfigurationProperty

Implements

CfnDeliveryStream.IIcebergDestinationConfigurationProperty

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.KinesisFirehose

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDeliveryStream.IcebergDestinationConfigurationProperty : CfnDeliveryStream.IIcebergDestinationConfigurationProperty

Syntax (vb)

Public Class CfnDeliveryStream.IcebergDestinationConfigurationProperty Implements CfnDeliveryStream.IIcebergDestinationConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.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.KinesisFirehose;

             var icebergDestinationConfigurationProperty = new IcebergDestinationConfigurationProperty {
                 CatalogConfiguration = new CatalogConfigurationProperty {
                     CatalogArn = "catalogArn"
                 },
                 RoleArn = "roleArn",
                 S3Configuration = new S3DestinationConfigurationProperty {
                     BucketArn = "bucketArn",
                     RoleArn = "roleArn",

                     // the properties below are optional
                     BufferingHints = new BufferingHintsProperty {
                         IntervalInSeconds = 123,
                         SizeInMBs = 123
                     },
                     CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                         Enabled = false,
                         LogGroupName = "logGroupName",
                         LogStreamName = "logStreamName"
                     },
                     CompressionFormat = "compressionFormat",
                     EncryptionConfiguration = new EncryptionConfigurationProperty {
                         KmsEncryptionConfig = new KMSEncryptionConfigProperty {
                             AwskmsKeyArn = "awskmsKeyArn"
                         },
                         NoEncryptionConfig = "noEncryptionConfig"
                     },
                     ErrorOutputPrefix = "errorOutputPrefix",
                     Prefix = "prefix"
                 },

                 // the properties below are optional
                 AppendOnly = false,
                 BufferingHints = new BufferingHintsProperty {
                     IntervalInSeconds = 123,
                     SizeInMBs = 123
                 },
                 CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                     Enabled = false,
                     LogGroupName = "logGroupName",
                     LogStreamName = "logStreamName"
                 },
                 DestinationTableConfigurationList = new [] { new DestinationTableConfigurationProperty {
                     DestinationDatabaseName = "destinationDatabaseName",
                     DestinationTableName = "destinationTableName",

                     // the properties below are optional
                     S3ErrorOutputPrefix = "s3ErrorOutputPrefix",
                     UniqueKeys = new [] { "uniqueKeys" }
                 } },
                 ProcessingConfiguration = new ProcessingConfigurationProperty {
                     Enabled = false,
                     Processors = new [] { new ProcessorProperty {
                         Type = "type",

                         // the properties below are optional
                         Parameters = new [] { new ProcessorParameterProperty {
                             ParameterName = "parameterName",
                             ParameterValue = "parameterValue"
                         } }
                     } }
                 },
                 RetryOptions = new RetryOptionsProperty {
                     DurationInSeconds = 123
                 },
                 S3BackupMode = "s3BackupMode"
             };

Synopsis

Constructors

IcebergDestinationConfigurationProperty()

Specifies the destination configure settings for Apache Iceberg Table.

Properties

AppendOnly	Describes whether all incoming data for this delivery stream will be append only (inserts only and not for updates and deletes) for Iceberg delivery.
BufferingHints	Specifies the destination configure settings for Apache Iceberg Table.
CatalogConfiguration	Configuration describing where the destination Apache Iceberg Tables are persisted.
CloudWatchLoggingOptions	Specifies the destination configure settings for Apache Iceberg Table.
DestinationTableConfigurationList	Provides a list of DestinationTableConfigurations which Firehose uses to deliver data to Apache Iceberg Tables.
ProcessingConfiguration	Specifies the destination configure settings for Apache Iceberg Table.
RetryOptions	Specifies the destination configure settings for Apache Iceberg Table.
RoleArn	The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.
S3BackupMode	Describes how Firehose will backup records.
S3Configuration	Specifies the destination configure settings for Apache Iceberg Table.

Constructors

IcebergDestinationConfigurationProperty()

Specifies the destination configure settings for Apache Iceberg Table.

public IcebergDestinationConfigurationProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.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.KinesisFirehose;

             var icebergDestinationConfigurationProperty = new IcebergDestinationConfigurationProperty {
                 CatalogConfiguration = new CatalogConfigurationProperty {
                     CatalogArn = "catalogArn"
                 },
                 RoleArn = "roleArn",
                 S3Configuration = new S3DestinationConfigurationProperty {
                     BucketArn = "bucketArn",
                     RoleArn = "roleArn",

                     // the properties below are optional
                     BufferingHints = new BufferingHintsProperty {
                         IntervalInSeconds = 123,
                         SizeInMBs = 123
                     },
                     CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                         Enabled = false,
                         LogGroupName = "logGroupName",
                         LogStreamName = "logStreamName"
                     },
                     CompressionFormat = "compressionFormat",
                     EncryptionConfiguration = new EncryptionConfigurationProperty {
                         KmsEncryptionConfig = new KMSEncryptionConfigProperty {
                             AwskmsKeyArn = "awskmsKeyArn"
                         },
                         NoEncryptionConfig = "noEncryptionConfig"
                     },
                     ErrorOutputPrefix = "errorOutputPrefix",
                     Prefix = "prefix"
                 },

                 // the properties below are optional
                 AppendOnly = false,
                 BufferingHints = new BufferingHintsProperty {
                     IntervalInSeconds = 123,
                     SizeInMBs = 123
                 },
                 CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                     Enabled = false,
                     LogGroupName = "logGroupName",
                     LogStreamName = "logStreamName"
                 },
                 DestinationTableConfigurationList = new [] { new DestinationTableConfigurationProperty {
                     DestinationDatabaseName = "destinationDatabaseName",
                     DestinationTableName = "destinationTableName",

                     // the properties below are optional
                     S3ErrorOutputPrefix = "s3ErrorOutputPrefix",
                     UniqueKeys = new [] { "uniqueKeys" }
                 } },
                 ProcessingConfiguration = new ProcessingConfigurationProperty {
                     Enabled = false,
                     Processors = new [] { new ProcessorProperty {
                         Type = "type",

                         // the properties below are optional
                         Parameters = new [] { new ProcessorParameterProperty {
                             ParameterName = "parameterName",
                             ParameterValue = "parameterValue"
                         } }
                     } }
                 },
                 RetryOptions = new RetryOptionsProperty {
                     DurationInSeconds = 123
                 },
                 S3BackupMode = "s3BackupMode"
             };

Properties

AppendOnly

Describes whether all incoming data for this delivery stream will be append only (inserts only and not for updates and deletes) for Iceberg delivery.

public object? AppendOnly { get; set; }

Property Value

object

Remarks

This feature is only applicable for Apache Iceberg Tables.

The default value is false. If you set this value to true, Firehose automatically increases the throughput limit of a stream based on the throttling levels of the stream. If you set this parameter to true for a stream with updates and deletes, you will see out of order delivery.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-appendonly

BufferingHints

Specifies the destination configure settings for Apache Iceberg Table.

public object? BufferingHints { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-bufferinghints

CatalogConfiguration

Configuration describing where the destination Apache Iceberg Tables are persisted.

public object CatalogConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-catalogconfiguration

CloudWatchLoggingOptions

Specifies the destination configure settings for Apache Iceberg Table.

public object? CloudWatchLoggingOptions { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-cloudwatchloggingoptions

DestinationTableConfigurationList

Provides a list of DestinationTableConfigurations which Firehose uses to deliver data to Apache Iceberg Tables.

public object? DestinationTableConfigurationList { get; set; }

Property Value

object

Remarks

Firehose will write data with insert if table specific configuration is not provided here.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-destinationtableconfigurationlist

ProcessingConfiguration

Specifies the destination configure settings for Apache Iceberg Table.

public object? ProcessingConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-processingconfiguration

RetryOptions

Specifies the destination configure settings for Apache Iceberg Table.

public object? RetryOptions { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-retryoptions

RoleArn

The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.

public string RoleArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-rolearn

S3BackupMode

Describes how Firehose will backup records.

public string? S3BackupMode { get; set; }

Property Value

string

Remarks

Currently,S3 backup only supports FailedDataOnly .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-s3backupmode

S3Configuration

Specifies the destination configure settings for Apache Iceberg Table.

public object S3Configuration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-s3configuration

Implements

CfnDeliveryStream.IIcebergDestinationConfigurationProperty