Package software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStream

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

The ExtendedS3DestinationConfiguration property type configures an Amazon S3 destination for an Amazon Kinesis Data Firehose delivery stream.

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.*;
 ExtendedS3DestinationConfigurationProperty extendedS3DestinationConfigurationProperty = ExtendedS3DestinationConfigurationProperty.builder()
         .bucketArn("bucketArn")
         .roleArn("roleArn")
         // the properties below are optional
         .bufferingHints(BufferingHintsProperty.builder()
                 .intervalInSeconds(123)
                 .sizeInMBs(123)
                 .build())
         .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
                 .enabled(false)
                 .logGroupName("logGroupName")
                 .logStreamName("logStreamName")
                 .build())
         .compressionFormat("compressionFormat")
         .customTimeZone("customTimeZone")
         .dataFormatConversionConfiguration(DataFormatConversionConfigurationProperty.builder()
                 .enabled(false)
                 .inputFormatConfiguration(InputFormatConfigurationProperty.builder()
                         .deserializer(DeserializerProperty.builder()
                                 .hiveJsonSerDe(HiveJsonSerDeProperty.builder()
                                         .timestampFormats(List.of("timestampFormats"))
                                         .build())
                                 .openXJsonSerDe(OpenXJsonSerDeProperty.builder()
                                         .caseInsensitive(false)
                                         .columnToJsonKeyMappings(Map.of(
                                                 "columnToJsonKeyMappingsKey", "columnToJsonKeyMappings"))
                                         .convertDotsInJsonKeysToUnderscores(false)
                                         .build())
                                 .build())
                         .build())
                 .outputFormatConfiguration(OutputFormatConfigurationProperty.builder()
                         .serializer(SerializerProperty.builder()
                                 .orcSerDe(OrcSerDeProperty.builder()
                                         .blockSizeBytes(123)
                                         .bloomFilterColumns(List.of("bloomFilterColumns"))
                                         .bloomFilterFalsePositiveProbability(123)
                                         .compression("compression")
                                         .dictionaryKeyThreshold(123)
                                         .enablePadding(false)
                                         .formatVersion("formatVersion")
                                         .paddingTolerance(123)
                                         .rowIndexStride(123)
                                         .stripeSizeBytes(123)
                                         .build())
                                 .parquetSerDe(ParquetSerDeProperty.builder()
                                         .blockSizeBytes(123)
                                         .compression("compression")
                                         .enableDictionaryCompression(false)
                                         .maxPaddingBytes(123)
                                         .pageSizeBytes(123)
                                         .writerVersion("writerVersion")
                                         .build())
                                 .build())
                         .build())
                 .schemaConfiguration(SchemaConfigurationProperty.builder()
                         .catalogId("catalogId")
                         .databaseName("databaseName")
                         .region("region")
                         .roleArn("roleArn")
                         .tableName("tableName")
                         .versionId("versionId")
                         .build())
                 .build())
         .dynamicPartitioningConfiguration(DynamicPartitioningConfigurationProperty.builder()
                 .enabled(false)
                 .retryOptions(RetryOptionsProperty.builder()
                         .durationInSeconds(123)
                         .build())
                 .build())
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder()
                         .awskmsKeyArn("awskmsKeyArn")
                         .build())
                 .noEncryptionConfig("noEncryptionConfig")
                 .build())
         .errorOutputPrefix("errorOutputPrefix")
         .fileExtension("fileExtension")
         .prefix("prefix")
         .processingConfiguration(ProcessingConfigurationProperty.builder()
                 .enabled(false)
                 .processors(List.of(ProcessorProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .parameters(List.of(ProcessorParameterProperty.builder()
                                 .parameterName("parameterName")
                                 .parameterValue("parameterValue")
                                 .build()))
                         .build()))
                 .build())
         .s3BackupConfiguration(S3DestinationConfigurationProperty.builder()
                 .bucketArn("bucketArn")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .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")
                 .build())
         .s3BackupMode("s3BackupMode")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty.Builder	builder()
String	getBucketArn()	The Amazon Resource Name (ARN) of the Amazon S3 bucket.
default Object	getBufferingHints()	The buffering option.
default Object	getCloudWatchLoggingOptions()	The Amazon CloudWatch logging options for your Firehose stream.
default String	getCompressionFormat()	The compression format.
default String	getCustomTimeZone()	The time zone you prefer.
default Object	getDataFormatConversionConfiguration()	The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
default Object	getDynamicPartitioningConfiguration()	The configuration of the dynamic partitioning mechanism that creates targeted data sets from the streaming data by partitioning it based on partition keys.
default Object	getEncryptionConfiguration()	The encryption configuration for the Kinesis Data Firehose delivery stream.
default String	getErrorOutputPrefix()	A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
default String	getFileExtension()	Specify a file extension.
default String	getPrefix()	The YYYY/MM/DD/HH time format prefix is automatically used for delivered Amazon S3 files.
default Object	getProcessingConfiguration()	The data processing configuration for the Kinesis Data Firehose delivery stream.
String	getRoleArn()	The Amazon Resource Name (ARN) of the AWS credentials.
default Object	getS3BackupConfiguration()	The configuration for backup in Amazon S3.
default String	getS3BackupMode()	The Amazon S3 backup mode.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucketArn

@Stability(Stable)
@NotNull
String getBucketArn()

The Amazon Resource Name (ARN) of the Amazon S3 bucket.

For constraints, see ExtendedS3DestinationConfiguration in the Amazon Kinesis Data Firehose API Reference .

See Also:

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

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The Amazon Resource Name (ARN) of the AWS credentials.

For constraints, see ExtendedS3DestinationConfiguration in the Amazon Kinesis Data Firehose API Reference .

See Also:

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

getBufferingHints

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

The buffering option.

See Also:

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

getCloudWatchLoggingOptions

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

The Amazon CloudWatch logging options for your Firehose stream.

See Also:

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

getCompressionFormat

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

The compression format.

If no value is specified, the default is UNCOMPRESSED .

See Also:

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

getCustomTimeZone

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

The time zone you prefer.

UTC is the default.

See Also:

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

getDataFormatConversionConfiguration

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

The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

See Also:

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

getDynamicPartitioningConfiguration

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

The configuration of the dynamic partitioning mechanism that creates targeted data sets from the streaming data by partitioning it based on partition keys.

See Also:

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

getEncryptionConfiguration

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

The encryption configuration for the Kinesis Data Firehose delivery stream.

The default value is NoEncryption .

See Also:

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

getErrorOutputPrefix

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

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.

This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects .

See Also:

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

getFileExtension

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

Specify a file extension.

It will override the default file extension

See Also:

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

getPrefix

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

The YYYY/MM/DD/HH time format prefix is automatically used for delivered Amazon S3 files.

For more information, see ExtendedS3DestinationConfiguration in the Amazon Kinesis Data Firehose API Reference .

See Also:

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

getProcessingConfiguration

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

The data processing configuration for the Kinesis Data Firehose delivery stream.

See Also:

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

getS3BackupConfiguration

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

The configuration for backup in Amazon S3.

See Also:

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

getS3BackupMode

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

The Amazon S3 backup mode.

After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.

See Also:

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

builder

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

Returns:

a CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty.Builder of CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty