Package software.amazon.awscdk.cfnpropertymixins.services.kinesisfirehose

Interface CfnDeliveryStreamPropsMixin.IcebergDestinationConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStreamPropsMixin.IcebergDestinationConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStreamPropsMixin

@Stability(Stable)
public static interface CfnDeliveryStreamPropsMixin.IcebergDestinationConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the destination configure settings for Apache Iceberg Table.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.kinesisfirehose.*;
 IcebergDestinationConfigurationProperty icebergDestinationConfigurationProperty = IcebergDestinationConfigurationProperty.builder()
         .appendOnly(false)
         .bufferingHints(BufferingHintsProperty.builder()
                 .intervalInSeconds(123)
                 .sizeInMBs(123)
                 .build())
         .catalogConfiguration(CatalogConfigurationProperty.builder()
                 .catalogArn("catalogArn")
                 .warehouseLocation("warehouseLocation")
                 .build())
         .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
                 .enabled(false)
                 .logGroupName("logGroupName")
                 .logStreamName("logStreamName")
                 .build())
         .destinationTableConfigurationList(List.of(DestinationTableConfigurationProperty.builder()
                 .destinationDatabaseName("destinationDatabaseName")
                 .destinationTableName("destinationTableName")
                 .partitionSpec(PartitionSpecProperty.builder()
                         .identity(List.of(PartitionFieldProperty.builder()
                                 .sourceName("sourceName")
                                 .build()))
                         .build())
                 .s3ErrorOutputPrefix("s3ErrorOutputPrefix")
                 .uniqueKeys(List.of("uniqueKeys"))
                 .build()))
         .processingConfiguration(ProcessingConfigurationProperty.builder()
                 .enabled(false)
                 .processors(List.of(ProcessorProperty.builder()
                         .parameters(List.of(ProcessorParameterProperty.builder()
                                 .parameterName("parameterName")
                                 .parameterValue("parameterValue")
                                 .build()))
                         .type("type")
                         .build()))
                 .build())
         .retryOptions(RetryOptionsProperty.builder()
                 .durationInSeconds(123)
                 .build())
         .roleArn("roleArn")
         .s3BackupMode("s3BackupMode")
         .s3Configuration(S3DestinationConfigurationProperty.builder()
                 .bucketArn("bucketArn")
                 .bufferingHints(BufferingHintsProperty.builder()
                         .intervalInSeconds(123)
                         .sizeInMBs(123)
                         .build())
                 .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
                         .enabled(false)
                         .logGroupName("logGroupName")
                         .logStreamName("logStreamName")
                         .build())
                 .compressionFormat("compressionFormat")
                 .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                         .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder()
                                 .awskmsKeyArn("awskmsKeyArn")
                                 .build())
                         .noEncryptionConfig("noEncryptionConfig")
                         .build())
                 .errorOutputPrefix("errorOutputPrefix")
                 .prefix("prefix")
                 .roleArn("roleArn")
                 .build())
         .schemaEvolutionConfiguration(SchemaEvolutionConfigurationProperty.builder()
                 .enabled(false)
                 .build())
         .tableCreationConfiguration(TableCreationConfigurationProperty.builder()
                 .enabled(false)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeliveryStreamPropsMixin.IcebergDestinationConfigurationProperty.Builder	A builder for CfnDeliveryStreamPropsMixin.IcebergDestinationConfigurationProperty
static final class	CfnDeliveryStreamPropsMixin.IcebergDestinationConfigurationProperty.Jsii$Proxy	An implementation for CfnDeliveryStreamPropsMixin.IcebergDestinationConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStreamPropsMixin.IcebergDestinationConfigurationProperty.Builder	builder()
default Object	getAppendOnly()	Describes whether all incoming data for this delivery stream will be append only (inserts only and not for updates and deletes) for Iceberg delivery.
default Object	getBufferingHints()	Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.BufferingHintsProperty
default Object	getCatalogConfiguration()	Configuration describing where the destination Apache Iceberg Tables are persisted.
default Object	getCloudWatchLoggingOptions()	Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.CloudWatchLoggingOptionsProperty
default Object	getDestinationTableConfigurationList()	Provides a list of DestinationTableConfigurations which Firehose uses to deliver data to Apache Iceberg Tables.
default Object	getProcessingConfiguration()	Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.ProcessingConfigurationProperty
default Object	getRetryOptions()	Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.RetryOptionsProperty
default String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.
default String	getS3BackupMode()	Describes how Firehose will backup records.
default Object	getS3Configuration()	Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.S3DestinationConfigurationProperty
default Object	getSchemaEvolutionConfiguration()	The configuration to enable automatic schema evolution.
default Object	getTableCreationConfiguration()	The configuration to enable automatic table creation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAppendOnly

@Stability(Stable)
@Nullable
default Object getAppendOnly()

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

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.

Returns union: either Boolean or IResolvable

See Also:

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

getBufferingHints

@Stability(Stable)
@Nullable
default Object getBufferingHints()

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.BufferingHintsProperty

See Also:

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

getCatalogConfiguration

@Stability(Stable)
@Nullable
default Object getCatalogConfiguration()

Configuration describing where the destination Apache Iceberg Tables are persisted.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.CatalogConfigurationProperty

See Also:

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

getCloudWatchLoggingOptions

@Stability(Stable)
@Nullable
default Object getCloudWatchLoggingOptions()

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.CloudWatchLoggingOptionsProperty

See Also:

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

getDestinationTableConfigurationList

@Stability(Stable)
@Nullable
default Object getDestinationTableConfigurationList()

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

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDeliveryStreamPropsMixin.DestinationTableConfigurationProperty>

See Also:

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

getProcessingConfiguration

@Stability(Stable)
@Nullable
default Object getProcessingConfiguration()

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.ProcessingConfigurationProperty

See Also:

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

getRetryOptions

@Stability(Stable)
@Nullable
default Object getRetryOptions()

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.RetryOptionsProperty

See Also:

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

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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

See Also:

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

getS3BackupMode

@Stability(Stable)
@Nullable
default String getS3BackupMode()

Describes how Firehose will backup records.

Currently,S3 backup only supports FailedDataOnly .

See Also:

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

getS3Configuration

@Stability(Stable)
@Nullable
default Object getS3Configuration()

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.S3DestinationConfigurationProperty

See Also:

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

getSchemaEvolutionConfiguration

@Stability(Stable)
@Nullable
default Object getSchemaEvolutionConfiguration()

The configuration to enable automatic schema evolution.

Amazon Data Firehose is in preview release and is subject to change.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.SchemaEvolutionConfigurationProperty

See Also:

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

getTableCreationConfiguration

@Stability(Stable)
@Nullable
default Object getTableCreationConfiguration()

The configuration to enable automatic table creation.

Amazon Data Firehose is in preview release and is subject to change.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.TableCreationConfigurationProperty

See Also:

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

builder

@Stability(Stable)
static CfnDeliveryStreamPropsMixin.IcebergDestinationConfigurationProperty.Builder builder()

Returns:

a CfnDeliveryStreamPropsMixin.IcebergDestinationConfigurationProperty.Builder of CfnDeliveryStreamPropsMixin.IcebergDestinationConfigurationProperty