Package software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.DestinationTableConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStream.DestinationTableConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStream

@Stability(Stable)
public static interface CfnDeliveryStream.DestinationTableConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Describes the configuration of a destination in Apache Iceberg Tables.

This section is only needed for tables where you want to update or delete data.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kinesisfirehose.*;
 DestinationTableConfigurationProperty destinationTableConfigurationProperty = DestinationTableConfigurationProperty.builder()
         .destinationDatabaseName("destinationDatabaseName")
         .destinationTableName("destinationTableName")
         // the properties below are optional
         .partitionSpec(PartitionSpecProperty.builder()
                 .identity(List.of(PartitionFieldProperty.builder()
                         .sourceName("sourceName")
                         .build()))
                 .build())
         .s3ErrorOutputPrefix("s3ErrorOutputPrefix")
         .uniqueKeys(List.of("uniqueKeys"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStream.DestinationTableConfigurationProperty.Builder	builder()
String	getDestinationDatabaseName()	The name of the Apache Iceberg database.
String	getDestinationTableName()	Specifies the name of the Apache Iceberg Table.
default Object	getPartitionSpec()	The partition spec configuration for a table that is used by automatic table creation.
default String	getS3ErrorOutputPrefix()	The table specific S3 error output prefix.
default List<String>	getUniqueKeys()	A list of unique keys for a given Apache Iceberg table.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestinationDatabaseName

@Stability(Stable)
@NotNull
String getDestinationDatabaseName()

The name of the Apache Iceberg database.

See Also:

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

getDestinationTableName

@Stability(Stable)
@NotNull
String getDestinationTableName()

Specifies the name of the Apache Iceberg Table.

See Also:

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

getPartitionSpec

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

The partition spec configuration for a table that is used by automatic table creation.

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

Returns union: either IResolvable or CfnDeliveryStream.PartitionSpecProperty

See Also:

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

getS3ErrorOutputPrefix

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

The table specific S3 error output prefix.

All the errors that occurred while delivering to this table will be prefixed with this value in S3 destination.

See Also:

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

getUniqueKeys

@Stability(Stable)
@Nullable
default List<String> getUniqueKeys()

A list of unique keys for a given Apache Iceberg table.

Firehose will use these for running Create, Update, or Delete operations on the given Iceberg table.

See Also:

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

builder

@Stability(Stable)
static CfnDeliveryStream.DestinationTableConfigurationProperty.Builder builder()

Returns:

a CfnDeliveryStream.DestinationTableConfigurationProperty.Builder of CfnDeliveryStream.DestinationTableConfigurationProperty