Interface CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnDeliveryStream
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:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
static final class
An implementation forCfnDeliveryStream.ExtendedS3DestinationConfigurationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The Amazon Resource Name (ARN) of the Amazon S3 bucket.default Object
The buffering option.default Object
The Amazon CloudWatch logging options for your Firehose stream.default String
The compression format.default String
The time zone you prefer.default Object
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
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
The encryption configuration for the Kinesis Data Firehose delivery stream.default String
A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.default String
Specify a file extension.default String
TheYYYY/MM/DD/HH
time format prefix is automatically used for delivered Amazon S3 files.default Object
The data processing configuration for the Kinesis Data Firehose delivery stream.The Amazon Resource Name (ARN) of the AWS credentials.default Object
The configuration for backup in Amazon S3.default String
The Amazon S3 backup mode.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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:
-
getRoleArn
The Amazon Resource Name (ARN) of the AWS credentials.For constraints, see ExtendedS3DestinationConfiguration in the Amazon Kinesis Data Firehose API Reference .
- See Also:
-
getBufferingHints
The buffering option.- See Also:
-
getCloudWatchLoggingOptions
The Amazon CloudWatch logging options for your Firehose stream.- See Also:
-
getCompressionFormat
The compression format.If no value is specified, the default is
UNCOMPRESSED
.- See Also:
-
getCustomTimeZone
The time zone you prefer.UTC is the default.
- See Also:
-
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:
-
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:
-
getEncryptionConfiguration
The encryption configuration for the Kinesis Data Firehose delivery stream.The default value is
NoEncryption
.- See Also:
-
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:
-
getFileExtension
Specify a file extension.It will override the default file extension
- See Also:
-
getPrefix
TheYYYY/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:
-
getProcessingConfiguration
The data processing configuration for the Kinesis Data Firehose delivery stream.- See Also:
-
getS3BackupConfiguration
The configuration for backup in Amazon S3.- See Also:
-
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:
-
builder
@Stability(Stable) static CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty.Builder builder()
-