DestinationConfig

class aws_cdk.aws_kinesisfirehose.DestinationConfig(*, dependables=None, extended_s3_destination_configuration=None)

Bases: object

(experimental) A Kinesis Data Firehose delivery stream destination configuration.

Parameters
  • dependables (Optional[Sequence[IDependable]]) – (experimental) Any resources that were created by the destination when binding it to the stack that must be deployed before the delivery stream is deployed. Default: []

  • extended_s3_destination_configuration (Union[ExtendedS3DestinationConfigurationProperty, Dict[str, Any], None]) – (experimental) S3 destination configuration properties. Default: - S3 destination is not used.

Stability

experimental

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_kinesisfirehose as kinesisfirehose
import aws_cdk.core as cdk

# dependable: cdk.IDependable

destination_config = kinesisfirehose.DestinationConfig(
    dependables=[dependable],
    extended_s3_destination_configuration=kinesisfirehose.CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty(
        bucket_arn="bucketArn",
        role_arn="roleArn",

        # the properties below are optional
        buffering_hints=kinesisfirehose.CfnDeliveryStream.BufferingHintsProperty(
            interval_in_seconds=123,
            size_in_mBs=123
        ),
        cloud_watch_logging_options=kinesisfirehose.CfnDeliveryStream.CloudWatchLoggingOptionsProperty(
            enabled=False,
            log_group_name="logGroupName",
            log_stream_name="logStreamName"
        ),
        compression_format="compressionFormat",
        data_format_conversion_configuration=kinesisfirehose.CfnDeliveryStream.DataFormatConversionConfigurationProperty(
            enabled=False,
            input_format_configuration=kinesisfirehose.CfnDeliveryStream.InputFormatConfigurationProperty(
                deserializer=kinesisfirehose.CfnDeliveryStream.DeserializerProperty(
                    hive_json_ser_de=kinesisfirehose.CfnDeliveryStream.HiveJsonSerDeProperty(
                        timestamp_formats=["timestampFormats"]
                    ),
                    open_xJson_ser_de=kinesisfirehose.CfnDeliveryStream.OpenXJsonSerDeProperty(
                        case_insensitive=False,
                        column_to_json_key_mappings={
                            "column_to_json_key_mappings_key": "columnToJsonKeyMappings"
                        },
                        convert_dots_in_json_keys_to_underscores=False
                    )
                )
            ),
            output_format_configuration=kinesisfirehose.CfnDeliveryStream.OutputFormatConfigurationProperty(
                serializer=kinesisfirehose.CfnDeliveryStream.SerializerProperty(
                    orc_ser_de=kinesisfirehose.CfnDeliveryStream.OrcSerDeProperty(
                        block_size_bytes=123,
                        bloom_filter_columns=["bloomFilterColumns"],
                        bloom_filter_false_positive_probability=123,
                        compression="compression",
                        dictionary_key_threshold=123,
                        enable_padding=False,
                        format_version="formatVersion",
                        padding_tolerance=123,
                        row_index_stride=123,
                        stripe_size_bytes=123
                    ),
                    parquet_ser_de=kinesisfirehose.CfnDeliveryStream.ParquetSerDeProperty(
                        block_size_bytes=123,
                        compression="compression",
                        enable_dictionary_compression=False,
                        max_padding_bytes=123,
                        page_size_bytes=123,
                        writer_version="writerVersion"
                    )
                )
            ),
            schema_configuration=kinesisfirehose.CfnDeliveryStream.SchemaConfigurationProperty(
                catalog_id="catalogId",
                database_name="databaseName",
                region="region",
                role_arn="roleArn",
                table_name="tableName",
                version_id="versionId"
            )
        ),
        dynamic_partitioning_configuration=kinesisfirehose.CfnDeliveryStream.DynamicPartitioningConfigurationProperty(
            enabled=False,
            retry_options=kinesisfirehose.CfnDeliveryStream.RetryOptionsProperty(
                duration_in_seconds=123
            )
        ),
        encryption_configuration=kinesisfirehose.CfnDeliveryStream.EncryptionConfigurationProperty(
            kms_encryption_config=kinesisfirehose.CfnDeliveryStream.KMSEncryptionConfigProperty(
                awskms_key_arn="awskmsKeyArn"
            ),
            no_encryption_config="noEncryptionConfig"
        ),
        error_output_prefix="errorOutputPrefix",
        prefix="prefix",
        processing_configuration=kinesisfirehose.CfnDeliveryStream.ProcessingConfigurationProperty(
            enabled=False,
            processors=[kinesisfirehose.CfnDeliveryStream.ProcessorProperty(
                type="type",

                # the properties below are optional
                parameters=[kinesisfirehose.CfnDeliveryStream.ProcessorParameterProperty(
                    parameter_name="parameterName",
                    parameter_value="parameterValue"
                )]
            )]
        ),
        s3_backup_configuration=kinesisfirehose.CfnDeliveryStream.S3DestinationConfigurationProperty(
            bucket_arn="bucketArn",
            role_arn="roleArn",

            # the properties below are optional
            buffering_hints=kinesisfirehose.CfnDeliveryStream.BufferingHintsProperty(
                interval_in_seconds=123,
                size_in_mBs=123
            ),
            cloud_watch_logging_options=kinesisfirehose.CfnDeliveryStream.CloudWatchLoggingOptionsProperty(
                enabled=False,
                log_group_name="logGroupName",
                log_stream_name="logStreamName"
            ),
            compression_format="compressionFormat",
            encryption_configuration=kinesisfirehose.CfnDeliveryStream.EncryptionConfigurationProperty(
                kms_encryption_config=kinesisfirehose.CfnDeliveryStream.KMSEncryptionConfigProperty(
                    awskms_key_arn="awskmsKeyArn"
                ),
                no_encryption_config="noEncryptionConfig"
            ),
            error_output_prefix="errorOutputPrefix",
            prefix="prefix"
        ),
        s3_backup_mode="s3BackupMode"
    )
)

Attributes

dependables

(experimental) Any resources that were created by the destination when binding it to the stack that must be deployed before the delivery stream is deployed.

Default

[]

Stability

experimental

Return type

Optional[List[IDependable]]

extended_s3_destination_configuration

(experimental) S3 destination configuration properties.

Default
  • S3 destination is not used.

Stability

experimental

Return type

Optional[ExtendedS3DestinationConfigurationProperty]