CfnDeliveryStream

class aws_cdk.aws_kinesisfirehose.CfnDeliveryStream(scope, id, *, amazonopensearchservice_destination_configuration=None, delivery_stream_encryption_configuration_input=None, delivery_stream_name=None, delivery_stream_type=None, elasticsearch_destination_configuration=None, extended_s3_destination_configuration=None, http_endpoint_destination_configuration=None, kinesis_stream_source_configuration=None, redshift_destination_configuration=None, s3_destination_configuration=None, splunk_destination_configuration=None, tags=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::KinesisFirehose::DeliveryStream.

The AWS::KinesisFirehose::DeliveryStream resource specifies an Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivery stream that delivers real-time streaming data to an Amazon Simple Storage Service (Amazon S3), Amazon Redshift, or Amazon Elasticsearch Service (Amazon ES) destination. For more information, see Creating an Amazon Kinesis Data Firehose Delivery Stream in the Amazon Kinesis Data Firehose Developer Guide .

CloudformationResource

AWS::KinesisFirehose::DeliveryStream

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html

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

cfn_delivery_stream = kinesisfirehose.CfnDeliveryStream(self, "MyCfnDeliveryStream",
    amazonopensearchservice_destination_configuration=kinesisfirehose.CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty(
        index_name="indexName",
        role_arn="roleArn",
        s3_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"
        ),

        # the properties below are optional
        buffering_hints=kinesisfirehose.CfnDeliveryStream.AmazonopensearchserviceBufferingHintsProperty(
            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"
        ),
        cluster_endpoint="clusterEndpoint",
        domain_arn="domainArn",
        index_rotation_period="indexRotationPeriod",
        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"
                )]
            )]
        ),
        retry_options=kinesisfirehose.CfnDeliveryStream.AmazonopensearchserviceRetryOptionsProperty(
            duration_in_seconds=123
        ),
        s3_backup_mode="s3BackupMode",
        type_name="typeName",
        vpc_configuration=kinesisfirehose.CfnDeliveryStream.VpcConfigurationProperty(
            role_arn="roleArn",
            security_group_ids=["securityGroupIds"],
            subnet_ids=["subnetIds"]
        )
    ),
    delivery_stream_encryption_configuration_input=kinesisfirehose.CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty(
        key_type="keyType",

        # the properties below are optional
        key_arn="keyArn"
    ),
    delivery_stream_name="deliveryStreamName",
    delivery_stream_type="deliveryStreamType",
    elasticsearch_destination_configuration=kinesisfirehose.CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty(
        index_name="indexName",
        role_arn="roleArn",
        s3_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"
        ),

        # the properties below are optional
        buffering_hints=kinesisfirehose.CfnDeliveryStream.ElasticsearchBufferingHintsProperty(
            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"
        ),
        cluster_endpoint="clusterEndpoint",
        domain_arn="domainArn",
        index_rotation_period="indexRotationPeriod",
        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"
                )]
            )]
        ),
        retry_options=kinesisfirehose.CfnDeliveryStream.ElasticsearchRetryOptionsProperty(
            duration_in_seconds=123
        ),
        s3_backup_mode="s3BackupMode",
        type_name="typeName",
        vpc_configuration=kinesisfirehose.CfnDeliveryStream.VpcConfigurationProperty(
            role_arn="roleArn",
            security_group_ids=["securityGroupIds"],
            subnet_ids=["subnetIds"]
        )
    ),
    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"
    ),
    http_endpoint_destination_configuration=kinesisfirehose.CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty(
        endpoint_configuration=kinesisfirehose.CfnDeliveryStream.HttpEndpointConfigurationProperty(
            url="url",

            # the properties below are optional
            access_key="accessKey",
            name="name"
        ),
        s3_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"
        ),

        # 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"
        ),
        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"
                )]
            )]
        ),
        request_configuration=kinesisfirehose.CfnDeliveryStream.HttpEndpointRequestConfigurationProperty(
            common_attributes=[kinesisfirehose.CfnDeliveryStream.HttpEndpointCommonAttributeProperty(
                attribute_name="attributeName",
                attribute_value="attributeValue"
            )],
            content_encoding="contentEncoding"
        ),
        retry_options=kinesisfirehose.CfnDeliveryStream.RetryOptionsProperty(
            duration_in_seconds=123
        ),
        role_arn="roleArn",
        s3_backup_mode="s3BackupMode"
    ),
    kinesis_stream_source_configuration=kinesisfirehose.CfnDeliveryStream.KinesisStreamSourceConfigurationProperty(
        kinesis_stream_arn="kinesisStreamArn",
        role_arn="roleArn"
    ),
    redshift_destination_configuration=kinesisfirehose.CfnDeliveryStream.RedshiftDestinationConfigurationProperty(
        cluster_jdbcurl="clusterJdbcurl",
        copy_command=kinesisfirehose.CfnDeliveryStream.CopyCommandProperty(
            data_table_name="dataTableName",

            # the properties below are optional
            copy_options="copyOptions",
            data_table_columns="dataTableColumns"
        ),
        password="password",
        role_arn="roleArn",
        s3_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"
        ),
        username="username",

        # the properties below are optional
        cloud_watch_logging_options=kinesisfirehose.CfnDeliveryStream.CloudWatchLoggingOptionsProperty(
            enabled=False,
            log_group_name="logGroupName",
            log_stream_name="logStreamName"
        ),
        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"
                )]
            )]
        ),
        retry_options=kinesisfirehose.CfnDeliveryStream.RedshiftRetryOptionsProperty(
            duration_in_seconds=123
        ),
        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"
    ),
    s3_destination_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"
    ),
    splunk_destination_configuration=kinesisfirehose.CfnDeliveryStream.SplunkDestinationConfigurationProperty(
        hec_endpoint="hecEndpoint",
        hec_endpoint_type="hecEndpointType",
        hec_token="hecToken",
        s3_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"
        ),

        # the properties below are optional
        cloud_watch_logging_options=kinesisfirehose.CfnDeliveryStream.CloudWatchLoggingOptionsProperty(
            enabled=False,
            log_group_name="logGroupName",
            log_stream_name="logStreamName"
        ),
        hec_acknowledgment_timeout_in_seconds=123,
        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"
                )]
            )]
        ),
        retry_options=kinesisfirehose.CfnDeliveryStream.SplunkRetryOptionsProperty(
            duration_in_seconds=123
        ),
        s3_backup_mode="s3BackupMode"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::KinesisFirehose::DeliveryStream.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • amazonopensearchservice_destination_configuration (Union[AmazonopensearchserviceDestinationConfigurationProperty, IResolvable, None]) – The destination in Amazon OpenSearch Service. You can specify only one destination.

  • delivery_stream_encryption_configuration_input (Union[IResolvable, DeliveryStreamEncryptionConfigurationInputProperty, None]) – Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

  • delivery_stream_name (Optional[str]) – The name of the delivery stream.

  • delivery_stream_type (Optional[str]) – The delivery stream type. This can be one of the following values:. - DirectPut : Provider applications access the delivery stream directly. - KinesisStreamAsSource : The delivery stream uses a Kinesis data stream as a source.

  • elasticsearch_destination_configuration (Union[IResolvable, ElasticsearchDestinationConfigurationProperty, None]) – An Amazon ES destination for the delivery stream. Conditional. You must specify only one destination configuration. If you change the delivery stream destination from an Amazon ES destination to an Amazon S3 or Amazon Redshift destination, update requires some interruptions .

  • extended_s3_destination_configuration (Union[ExtendedS3DestinationConfigurationProperty, IResolvable, None]) –

    An Amazon S3 destination for the delivery stream. Conditional. You must specify only one destination configuration. If you change the delivery stream destination from an Amazon Extended S3 destination to an Amazon ES destination, update requires some interruptions .

  • http_endpoint_destination_configuration (Union[IResolvable, HttpEndpointDestinationConfigurationProperty, None]) – Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.

  • kinesis_stream_source_configuration (Union[IResolvable, KinesisStreamSourceConfigurationProperty, None]) – When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.

  • redshift_destination_configuration (Union[IResolvable, RedshiftDestinationConfigurationProperty, None]) –

    An Amazon Redshift destination for the delivery stream. Conditional. You must specify only one destination configuration. If you change the delivery stream destination from an Amazon Redshift destination to an Amazon ES destination, update requires some interruptions .

  • s3_destination_configuration (Union[IResolvable, S3DestinationConfigurationProperty, None]) –

    The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data. Conditional. You must specify only one destination configuration. If you change the delivery stream destination from an Amazon S3 destination to an Amazon ES destination, update requires some interruptions .

  • splunk_destination_configuration (Union[IResolvable, SplunkDestinationConfigurationProperty, None]) – The configuration of a destination in Splunk for the delivery stream.

  • tags (Optional[Sequence[CfnTag]]) – A set of tags to assign to the delivery stream. A tag is a key-value pair that you can define and assign to AWS resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. You can specify up to 50 tags when creating a delivery stream.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::KinesisFirehose::DeliveryStream'
amazonopensearchservice_destination_configuration

The destination in Amazon OpenSearch Service.

You can specify only one destination.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration

Return type

Union[AmazonopensearchserviceDestinationConfigurationProperty, IResolvable, None]

attr_arn

The Amazon Resource Name (ARN) of the delivery stream, such as arn:aws:firehose:us-east-2:123456789012:deliverystream/delivery-stream-name .

CloudformationAttribute

Arn

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

delivery_stream_encryption_configuration_input

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput

Return type

Union[IResolvable, DeliveryStreamEncryptionConfigurationInputProperty, None]

delivery_stream_name

The name of the delivery stream.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamname

Return type

Optional[str]

delivery_stream_type

.

  • DirectPut : Provider applications access the delivery stream directly.

  • KinesisStreamAsSource : The delivery stream uses a Kinesis data stream as a source.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamtype

Type

The delivery stream type. This can be one of the following values

Return type

Optional[str]

elasticsearch_destination_configuration

An Amazon ES destination for the delivery stream.

Conditional. You must specify only one destination configuration.

If you change the delivery stream destination from an Amazon ES destination to an Amazon S3 or Amazon Redshift destination, update requires some interruptions .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration

Return type

Union[IResolvable, ElasticsearchDestinationConfigurationProperty, None]

extended_s3_destination_configuration

An Amazon S3 destination for the delivery stream.

Conditional. You must specify only one destination configuration.

If you change the delivery stream destination from an Amazon Extended S3 destination to an Amazon ES destination, update requires some interruptions .

Link

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

Return type

Union[ExtendedS3DestinationConfigurationProperty, IResolvable, None]

http_endpoint_destination_configuration

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.

You can specify only one destination.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration

Return type

Union[IResolvable, HttpEndpointDestinationConfigurationProperty, None]

kinesis_stream_source_configuration

//docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html>`_ containing the Kinesis stream ARN and the role ARN for the source stream.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration

Type

When a Kinesis stream is used as the source for the delivery stream, a `KinesisStreamSourceConfiguration <https

Return type

Union[IResolvable, KinesisStreamSourceConfigurationProperty, None]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

redshift_destination_configuration

An Amazon Redshift destination for the delivery stream.

Conditional. You must specify only one destination configuration.

If you change the delivery stream destination from an Amazon Redshift destination to an Amazon ES destination, update requires some interruptions .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration

Return type

Union[IResolvable, RedshiftDestinationConfigurationProperty, None]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

s3_destination_configuration

The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

Conditional. You must specify only one destination configuration.

If you change the delivery stream destination from an Amazon S3 destination to an Amazon ES destination, update requires some interruptions .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration

Return type

Union[IResolvable, S3DestinationConfigurationProperty, None]

splunk_destination_configuration

The configuration of a destination in Splunk for the delivery stream.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration

Return type

Union[IResolvable, SplunkDestinationConfigurationProperty, None]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

A set of tags to assign to the delivery stream.

A tag is a key-value pair that you can define and assign to AWS resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

You can specify up to 50 tags when creating a delivery stream.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-tags

Return type

TagManager

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AmazonopensearchserviceBufferingHintsProperty

class CfnDeliveryStream.AmazonopensearchserviceBufferingHintsProperty(*, interval_in_seconds=None, size_in_m_bs=None)

Bases: object

Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.

Parameters
  • interval_in_seconds (Union[int, float, None]) – Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).

  • size_in_m_bs (Union[int, float, None]) – Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.

Link

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

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

amazonopensearchservice_buffering_hints_property = kinesisfirehose.CfnDeliveryStream.AmazonopensearchserviceBufferingHintsProperty(
    interval_in_seconds=123,
    size_in_mBs=123
)

Attributes

interval_in_seconds

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination.

The default value is 300 (5 minutes).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints-intervalinseconds

Return type

Union[int, float, None]

size_in_m_bs

Buffer incoming data to the specified size, in MBs, before delivering it to the destination.

The default value is 5. We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints-sizeinmbs

Return type

Union[int, float, None]

AmazonopensearchserviceDestinationConfigurationProperty

class CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty(*, index_name, role_arn, s3_configuration, buffering_hints=None, cloud_watch_logging_options=None, cluster_endpoint=None, domain_arn=None, index_rotation_period=None, processing_configuration=None, retry_options=None, s3_backup_mode=None, type_name=None, vpc_configuration=None)

Bases: object

Describes the configuration of a destination in Amazon OpenSearch Service.

Parameters
  • index_name (str) – The Amazon OpenSearch Service index name.

  • role_arn (str) – The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.

  • s3_configuration (Union[IResolvable, S3DestinationConfigurationProperty]) – Describes the configuration of a destination in Amazon S3.

  • buffering_hints (Union[IResolvable, AmazonopensearchserviceBufferingHintsProperty, None]) – The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.

  • cloud_watch_logging_options (Union[IResolvable, CloudWatchLoggingOptionsProperty, None]) – Describes the Amazon CloudWatch logging options for your delivery stream.

  • cluster_endpoint (Optional[str]) – The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

  • domain_arn (Optional[str]) – The ARN of the Amazon OpenSearch Service domain.

  • index_rotation_period (Optional[str]) – The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.

  • processing_configuration (Union[IResolvable, ProcessingConfigurationProperty, None]) – Describes a data processing configuration.

  • retry_options (Union[IResolvable, AmazonopensearchserviceRetryOptionsProperty, None]) – The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).

  • s3_backup_mode (Optional[str]) – Defines how documents should be delivered to Amazon S3.

  • type_name (Optional[str]) – The Amazon OpenSearch Service type name.

  • vpc_configuration (Union[IResolvable, VpcConfigurationProperty, None]) – The details of the VPC of the Amazon OpenSearch Service destination.

Link

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

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

amazonopensearchservice_destination_configuration_property = kinesisfirehose.CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty(
    index_name="indexName",
    role_arn="roleArn",
    s3_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"
    ),

    # the properties below are optional
    buffering_hints=kinesisfirehose.CfnDeliveryStream.AmazonopensearchserviceBufferingHintsProperty(
        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"
    ),
    cluster_endpoint="clusterEndpoint",
    domain_arn="domainArn",
    index_rotation_period="indexRotationPeriod",
    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"
            )]
        )]
    ),
    retry_options=kinesisfirehose.CfnDeliveryStream.AmazonopensearchserviceRetryOptionsProperty(
        duration_in_seconds=123
    ),
    s3_backup_mode="s3BackupMode",
    type_name="typeName",
    vpc_configuration=kinesisfirehose.CfnDeliveryStream.VpcConfigurationProperty(
        role_arn="roleArn",
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
)

Attributes

buffering_hints

The buffering options.

If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.

Link

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

Return type

Union[IResolvable, AmazonopensearchserviceBufferingHintsProperty, None]

cloud_watch_logging_options

Describes the Amazon CloudWatch logging options for your delivery stream.

Link

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

Return type

Union[IResolvable, CloudWatchLoggingOptionsProperty, None]

cluster_endpoint

The endpoint to use when communicating with the cluster.

Specify either this ClusterEndpoint or the DomainARN field.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-clusterendpoint

Return type

Optional[str]

domain_arn

The ARN of the Amazon OpenSearch Service domain.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-domainarn

Return type

Optional[str]

index_name

The Amazon OpenSearch Service index name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-indexname

Return type

str

index_rotation_period

The Amazon OpenSearch Service index rotation period.

Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-indexrotationperiod

Return type

Optional[str]

processing_configuration

Describes a data processing configuration.

Link

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

Return type

Union[IResolvable, ProcessingConfigurationProperty, None]

retry_options

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.

The default value is 300 (5 minutes).

Link

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

Return type

Union[IResolvable, AmazonopensearchserviceRetryOptionsProperty, None]

role_arn

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.

Link

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

Return type

str

s3_backup_mode

Defines how documents should be delivered to Amazon S3.

Link

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

Return type

Optional[str]

s3_configuration

Describes the configuration of a destination in Amazon S3.

Link

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

Return type

Union[IResolvable, S3DestinationConfigurationProperty]

type_name

The Amazon OpenSearch Service type name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-typename

Return type

Optional[str]

vpc_configuration

The details of the VPC of the Amazon OpenSearch Service destination.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-vpcconfiguration

Return type

Union[IResolvable, VpcConfigurationProperty, None]

AmazonopensearchserviceRetryOptionsProperty

class CfnDeliveryStream.AmazonopensearchserviceRetryOptionsProperty(*, duration_in_seconds=None)

Bases: object

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.

Parameters

duration_in_seconds (Union[int, float, None]) – After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

Link

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

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

amazonopensearchservice_retry_options_property = kinesisfirehose.CfnDeliveryStream.AmazonopensearchserviceRetryOptionsProperty(
    duration_in_seconds=123
)

Attributes

duration_in_seconds

After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt).

After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserviceretryoptions.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserviceretryoptions-durationinseconds

Return type

Union[int, float, None]

BufferingHintsProperty

class CfnDeliveryStream.BufferingHintsProperty(*, interval_in_seconds=None, size_in_m_bs=None)

Bases: object

The BufferingHints property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose) buffers incoming data before delivering it to the destination.

The first buffer condition that is satisfied triggers Kinesis Data Firehose to deliver the data.

Parameters
  • interval_in_seconds (Union[int, float, None]) – The length of time, in seconds, that Kinesis Data Firehose buffers incoming data before delivering it to the destination. For valid values, see the IntervalInSeconds content for the BufferingHints data type in the Amazon Kinesis Data Firehose API Reference .

  • size_in_m_bs (Union[int, float, None]) –

    The size of the buffer, in MBs, that Kinesis Data Firehose uses for incoming data before delivering it to the destination. For valid values, see the SizeInMBs content for the BufferingHints data type in the Amazon Kinesis Data Firehose API Reference .

Link

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

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

buffering_hints_property = kinesisfirehose.CfnDeliveryStream.BufferingHintsProperty(
    interval_in_seconds=123,
    size_in_mBs=123
)

Attributes

interval_in_seconds

The length of time, in seconds, that Kinesis Data Firehose buffers incoming data before delivering it to the destination.

For valid values, see the IntervalInSeconds content for the BufferingHints data type in the Amazon Kinesis Data Firehose API Reference .

Link

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

Return type

Union[int, float, None]

size_in_m_bs

The size of the buffer, in MBs, that Kinesis Data Firehose uses for incoming data before delivering it to the destination.

For valid values, see the SizeInMBs content for the BufferingHints data type in the Amazon Kinesis Data Firehose API Reference .

Link

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

Return type

Union[int, float, None]

CloudWatchLoggingOptionsProperty

class CfnDeliveryStream.CloudWatchLoggingOptionsProperty(*, enabled=None, log_group_name=None, log_stream_name=None)

Bases: object

The CloudWatchLoggingOptions property type specifies Amazon CloudWatch Logs (CloudWatch Logs) logging options that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses for the delivery stream.

Parameters
  • enabled (Union[bool, IResolvable, None]) – Indicates whether CloudWatch Logs logging is enabled.

  • log_group_name (Optional[str]) – The name of the CloudWatch Logs log group that contains the log stream that Kinesis Data Firehose will use. Conditional. If you enable logging, you must specify this property.

  • log_stream_name (Optional[str]) – The name of the CloudWatch Logs log stream that Kinesis Data Firehose uses to send logs about data delivery. Conditional. If you enable logging, you must specify this property.

Link

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

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

cloud_watch_logging_options_property = kinesisfirehose.CfnDeliveryStream.CloudWatchLoggingOptionsProperty(
    enabled=False,
    log_group_name="logGroupName",
    log_stream_name="logStreamName"
)

Attributes

enabled

Indicates whether CloudWatch Logs logging is enabled.

Link

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

Return type

Union[bool, IResolvable, None]

log_group_name

The name of the CloudWatch Logs log group that contains the log stream that Kinesis Data Firehose will use.

Conditional. If you enable logging, you must specify this property.

Link

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

Return type

Optional[str]

log_stream_name

The name of the CloudWatch Logs log stream that Kinesis Data Firehose uses to send logs about data delivery.

Conditional. If you enable logging, you must specify this property.

Link

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

Return type

Optional[str]

CopyCommandProperty

class CfnDeliveryStream.CopyCommandProperty(*, data_table_name, copy_options=None, data_table_columns=None)

Bases: object

The CopyCommand property type configures the Amazon Redshift COPY command that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses to load data into an Amazon Redshift cluster from an Amazon S3 bucket.

Parameters
  • data_table_name (str) – The name of the target table. The table must already exist in the database.

  • copy_options (Optional[str]) – Parameters to use with the Amazon Redshift COPY command. For examples, see the CopyOptions content for the CopyCommand data type in the Amazon Kinesis Data Firehose API Reference .

  • data_table_columns (Optional[str]) – A comma-separated list of column names.

Link

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

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

copy_command_property = kinesisfirehose.CfnDeliveryStream.CopyCommandProperty(
    data_table_name="dataTableName",

    # the properties below are optional
    copy_options="copyOptions",
    data_table_columns="dataTableColumns"
)

Attributes

copy_options

Parameters to use with the Amazon Redshift COPY command.

For examples, see the CopyOptions content for the CopyCommand data type in the Amazon Kinesis Data Firehose API Reference .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-copyoptions

Return type

Optional[str]

data_table_columns

A comma-separated list of column names.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-datatablecolumns

Return type

Optional[str]

data_table_name

The name of the target table.

The table must already exist in the database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-datatablename

Return type

str

DataFormatConversionConfigurationProperty

class CfnDeliveryStream.DataFormatConversionConfigurationProperty(*, enabled=None, input_format_configuration=None, output_format_configuration=None, schema_configuration=None)

Bases: object

Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the AWS Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion .

Parameters
  • enabled (Union[bool, IResolvable, None]) – Defaults to true . Set it to false if you want to disable format conversion while preserving the configuration details.

  • input_format_configuration (Union[IResolvable, InputFormatConfigurationProperty, None]) – Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON. This parameter is required if Enabled is set to true.

  • output_format_configuration (Union[IResolvable, OutputFormatConfigurationProperty, None]) – Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if Enabled is set to true.

  • schema_configuration (Union[IResolvable, SchemaConfigurationProperty, None]) – Specifies the AWS Glue Data Catalog table that contains the column information. This parameter is required if Enabled is set to true.

Link

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

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

data_format_conversion_configuration_property = 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"
    )
)

Attributes

enabled

Defaults to true .

Set it to false if you want to disable format conversion while preserving the configuration details.

Link

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

Return type

Union[bool, IResolvable, None]

input_format_configuration

Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON.

This parameter is required if Enabled is set to true.

Link

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

Return type

Union[IResolvable, InputFormatConfigurationProperty, None]

output_format_configuration

Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format.

This parameter is required if Enabled is set to true.

Link

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

Return type

Union[IResolvable, OutputFormatConfigurationProperty, None]

schema_configuration

Specifies the AWS Glue Data Catalog table that contains the column information.

This parameter is required if Enabled is set to true.

Link

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

Return type

Union[IResolvable, SchemaConfigurationProperty, None]

DeliveryStreamEncryptionConfigurationInputProperty

class CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty(*, key_type, key_arn=None)

Bases: object

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

Parameters
  • key_type (str) – Indicates the type of customer master key (CMK) to use for encryption. The default setting is AWS_OWNED_CMK . For more information about CMKs, see Customer Master Keys (CMKs) . You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. .. epigraph:: To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn’t support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the AWS Key Management Service developer guide.

  • key_arn (Optional[str]) – If you set KeyType to CUSTOMER_MANAGED_CMK , you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to AWS _OWNED_CMK , Kinesis Data Firehose uses a service-account CMK.

Link

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

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

delivery_stream_encryption_configuration_input_property = kinesisfirehose.CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty(
    key_type="keyType",

    # the properties below are optional
    key_arn="keyArn"
)

Attributes

key_arn

If you set KeyType to CUSTOMER_MANAGED_CMK , you must specify the Amazon Resource Name (ARN) of the CMK.

If you set KeyType to AWS _OWNED_CMK , Kinesis Data Firehose uses a service-account CMK.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput.html#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-keyarn

Return type

Optional[str]

key_type

Indicates the type of customer master key (CMK) to use for encryption.

The default setting is AWS_OWNED_CMK . For more information about CMKs, see Customer Master Keys (CMKs) .

You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. .. epigraph:

To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see `About Symmetric and Asymmetric CMKs <https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html>`_ in the AWS Key Management Service developer guide.
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput.html#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-keytype

Return type

str

DeserializerProperty

class CfnDeliveryStream.DeserializerProperty(*, hive_json_ser_de=None, open_x_json_ser_de=None)

Bases: object

The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON.

Kinesis Data Firehose then serializes the data to its final format using the Serializer . Kinesis Data Firehose supports two types of deserializers: the Apache Hive JSON SerDe and the OpenX JSON SerDe .

Parameters
  • hive_json_ser_de (Union[IResolvable, HiveJsonSerDeProperty, None]) – The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.

  • open_x_json_ser_de (Union[IResolvable, OpenXJsonSerDeProperty, None]) – The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.

Link

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

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

deserializer_property = 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
    )
)

Attributes

hive_json_ser_de

The native Hive / HCatalog JsonSerDe.

Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deserializer.html#cfn-kinesisfirehose-deliverystream-deserializer-hivejsonserde

Return type

Union[IResolvable, HiveJsonSerDeProperty, None]

open_x_json_ser_de

The OpenX SerDe.

Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deserializer.html#cfn-kinesisfirehose-deliverystream-deserializer-openxjsonserde

Return type

Union[IResolvable, OpenXJsonSerDeProperty, None]

DynamicPartitioningConfigurationProperty

class CfnDeliveryStream.DynamicPartitioningConfigurationProperty(*, enabled=None, retry_options=None)

Bases: object

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

Parameters
  • enabled (Union[bool, IResolvable, None]) – Specifies whether dynamic partitioning is enabled for this Kinesis Data Firehose delivery stream.

  • retry_options (Union[IResolvable, RetryOptionsProperty, None]) – Specifies the retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.

Link

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

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

dynamic_partitioning_configuration_property = kinesisfirehose.CfnDeliveryStream.DynamicPartitioningConfigurationProperty(
    enabled=False,
    retry_options=kinesisfirehose.CfnDeliveryStream.RetryOptionsProperty(
        duration_in_seconds=123
    )
)

Attributes

enabled

Specifies whether dynamic partitioning is enabled for this Kinesis Data Firehose delivery stream.

Link

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

Return type

Union[bool, IResolvable, None]

retry_options

Specifies the retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.

Link

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

Return type

Union[IResolvable, RetryOptionsProperty, None]

ElasticsearchBufferingHintsProperty

class CfnDeliveryStream.ElasticsearchBufferingHintsProperty(*, interval_in_seconds=None, size_in_m_bs=None)

Bases: object

The ElasticsearchBufferingHints property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose) buffers incoming data while delivering it to the destination.

The first buffer condition that is satisfied triggers Kinesis Data Firehose to deliver the data.

ElasticsearchBufferingHints is the property type for the BufferingHints property of the Amazon Kinesis Data Firehose DeliveryStream ElasticsearchDestinationConfiguration property type.

Parameters
  • interval_in_seconds (Union[int, float, None]) –

    The length of time, in seconds, that Kinesis Data Firehose buffers incoming data before delivering it to the destination. For valid values, see the IntervalInSeconds content for the BufferingHints data type in the Amazon Kinesis Data Firehose API Reference .

  • size_in_m_bs (Union[int, float, None]) –

    The size of the buffer, in MBs, that Kinesis Data Firehose uses for incoming data before delivering it to the destination. For valid values, see the SizeInMBs content for the BufferingHints data type in the Amazon Kinesis Data Firehose API Reference .

Link

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

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

elasticsearch_buffering_hints_property = kinesisfirehose.CfnDeliveryStream.ElasticsearchBufferingHintsProperty(
    interval_in_seconds=123,
    size_in_mBs=123
)

Attributes

interval_in_seconds

The length of time, in seconds, that Kinesis Data Firehose buffers incoming data before delivering it to the destination.

For valid values, see the IntervalInSeconds content for the BufferingHints data type in the Amazon Kinesis Data Firehose API Reference .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.html#cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-intervalinseconds

Return type

Union[int, float, None]

size_in_m_bs

The size of the buffer, in MBs, that Kinesis Data Firehose uses for incoming data before delivering it to the destination.

For valid values, see the SizeInMBs content for the BufferingHints data type in the Amazon Kinesis Data Firehose API Reference .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.html#cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-sizeinmbs

Return type

Union[int, float, None]

ElasticsearchDestinationConfigurationProperty

class CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty(*, index_name, role_arn, s3_configuration, buffering_hints=None, cloud_watch_logging_options=None, cluster_endpoint=None, domain_arn=None, index_rotation_period=None, processing_configuration=None, retry_options=None, s3_backup_mode=None, type_name=None, vpc_configuration=None)

Bases: object

The ElasticsearchDestinationConfiguration property type specifies an Amazon Elasticsearch Service (Amazon ES) domain that Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data to.

Parameters
  • index_name (str) – The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing.

  • role_arn (str) – The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Controlling Access with Amazon Kinesis Data Firehose .

  • s3_configuration (Union[IResolvable, S3DestinationConfigurationProperty]) – The S3 bucket where Kinesis Data Firehose backs up incoming data.

  • buffering_hints (Union[IResolvable, ElasticsearchBufferingHintsProperty, None]) – Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.

  • cloud_watch_logging_options (Union[IResolvable, CloudWatchLoggingOptionsProperty, None]) – The Amazon CloudWatch Logs logging options for the delivery stream.

  • cluster_endpoint (Optional[str]) – The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

  • domain_arn (Optional[str]) – The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain , DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN . Specify either ClusterEndpoint or DomainARN .

  • index_rotation_period (Optional[str]) – The frequency of Elasticsearch index rotation. If you enable index rotation, Kinesis Data Firehose appends a portion of the UTC arrival timestamp to the specified index name, and rotates the appended timestamp accordingly. For more information, see Index Rotation for the Amazon ES Destination in the Amazon Kinesis Data Firehose Developer Guide .

  • processing_configuration (Union[IResolvable, ProcessingConfigurationProperty, None]) – The data processing configuration for the Kinesis Data Firehose delivery stream.

  • retry_options (Union[IResolvable, ElasticsearchRetryOptionsProperty, None]) – The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.

  • s3_backup_mode (Optional[str]) – The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3). You can send Amazon S3 all documents (all data) or only the documents that Kinesis Data Firehose could not deliver to the Amazon ES destination. For more information and valid values, see the S3BackupMode content for the ElasticsearchDestinationConfiguration data type in the Amazon Kinesis Data Firehose API Reference .

  • type_name (Optional[str]) – The Elasticsearch type name that Amazon ES adds to documents when indexing data.

  • vpc_configuration (Union[IResolvable, VpcConfigurationProperty, None]) – The details of the VPC of the Amazon ES destination.

Link

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

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

elasticsearch_destination_configuration_property = kinesisfirehose.CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty(
    index_name="indexName",
    role_arn="roleArn",
    s3_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"
    ),

    # the properties below are optional
    buffering_hints=kinesisfirehose.CfnDeliveryStream.ElasticsearchBufferingHintsProperty(
        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"
    ),
    cluster_endpoint="clusterEndpoint",
    domain_arn="domainArn",
    index_rotation_period="indexRotationPeriod",
    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"
            )]
        )]
    ),
    retry_options=kinesisfirehose.CfnDeliveryStream.ElasticsearchRetryOptionsProperty(
        duration_in_seconds=123
    ),
    s3_backup_mode="s3BackupMode",
    type_name="typeName",
    vpc_configuration=kinesisfirehose.CfnDeliveryStream.VpcConfigurationProperty(
        role_arn="roleArn",
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
)

Attributes

buffering_hints

Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.

Link

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

Return type

Union[IResolvable, ElasticsearchBufferingHintsProperty, None]

cloud_watch_logging_options

The Amazon CloudWatch Logs logging options for the delivery stream.

Link

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

Return type

Union[IResolvable, CloudWatchLoggingOptionsProperty, None]

cluster_endpoint

The endpoint to use when communicating with the cluster.

Specify either this ClusterEndpoint or the DomainARN field.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-clusterendpoint

Return type

Optional[str]

domain_arn

The ARN of the Amazon ES domain.

The IAM role must have permissions for DescribeElasticsearchDomain , DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN .

Specify either ClusterEndpoint or DomainARN .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-domainarn

Return type

Optional[str]

index_name

The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexname

Return type

str

index_rotation_period

The frequency of Elasticsearch index rotation.

If you enable index rotation, Kinesis Data Firehose appends a portion of the UTC arrival timestamp to the specified index name, and rotates the appended timestamp accordingly. For more information, see Index Rotation for the Amazon ES Destination in the Amazon Kinesis Data Firehose Developer Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexrotationperiod

Return type

Optional[str]

processing_configuration

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

Link

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

Return type

Union[IResolvable, ProcessingConfigurationProperty, None]

retry_options

The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.

Link

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

Return type

Union[IResolvable, ElasticsearchRetryOptionsProperty, None]

role_arn

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents.

For more information, see Controlling Access with Amazon Kinesis Data Firehose .

Link

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

Return type

str

s3_backup_mode

The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3).

You can send Amazon S3 all documents (all data) or only the documents that Kinesis Data Firehose could not deliver to the Amazon ES destination. For more information and valid values, see the S3BackupMode content for the ElasticsearchDestinationConfiguration data type in the Amazon Kinesis Data Firehose API Reference .

Link

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

Return type

Optional[str]

s3_configuration

The S3 bucket where Kinesis Data Firehose backs up incoming data.

Link

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

Return type

Union[IResolvable, S3DestinationConfigurationProperty]

type_name

The Elasticsearch type name that Amazon ES adds to documents when indexing data.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-typename

Return type

Optional[str]

vpc_configuration

The details of the VPC of the Amazon ES destination.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-vpcconfiguration

Return type

Union[IResolvable, VpcConfigurationProperty, None]

ElasticsearchRetryOptionsProperty

class CfnDeliveryStream.ElasticsearchRetryOptionsProperty(*, duration_in_seconds=None)

Bases: object

The ElasticsearchRetryOptions property type configures the retry behavior for when Amazon Kinesis Data Firehose (Kinesis Data Firehose) can’t deliver data to Amazon Elasticsearch Service (Amazon ES).

Parameters

duration_in_seconds (Union[int, float, None]) – After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose re-attempts delivery (including the first attempt). If Kinesis Data Firehose can’t deliver the data within the specified time, it writes the data to the backup S3 bucket. For valid values, see the DurationInSeconds content for the ElasticsearchRetryOptions data type in the Amazon Kinesis Data Firehose API Reference .

Link

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

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

elasticsearch_retry_options_property = kinesisfirehose.CfnDeliveryStream.ElasticsearchRetryOptionsProperty(
    duration_in_seconds=123
)

Attributes

duration_in_seconds

After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose re-attempts delivery (including the first attempt).

If Kinesis Data Firehose can’t deliver the data within the specified time, it writes the data to the backup S3 bucket. For valid values, see the DurationInSeconds content for the ElasticsearchRetryOptions data type in the Amazon Kinesis Data Firehose API Reference .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchretryoptions.html#cfn-kinesisfirehose-deliverystream-elasticsearchretryoptions-durationinseconds

Return type

Union[int, float, None]

EncryptionConfigurationProperty

class CfnDeliveryStream.EncryptionConfigurationProperty(*, kms_encryption_config=None, no_encryption_config=None)

Bases: object

The EncryptionConfiguration property type specifies the encryption settings that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses when delivering data to Amazon Simple Storage Service (Amazon S3).

Parameters
  • kms_encryption_config (Union[IResolvable, KMSEncryptionConfigProperty, None]) – The AWS Key Management Service ( AWS KMS) encryption key that Amazon S3 uses to encrypt your data.

  • no_encryption_config (Optional[str]) – Disables encryption. For valid values, see the NoEncryptionConfig content for the EncryptionConfiguration data type in the Amazon Kinesis Data Firehose API Reference .

Link

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

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

encryption_configuration_property = kinesisfirehose.CfnDeliveryStream.EncryptionConfigurationProperty(
    kms_encryption_config=kinesisfirehose.CfnDeliveryStream.KMSEncryptionConfigProperty(
        awskms_key_arn="awskmsKeyArn"
    ),
    no_encryption_config="noEncryptionConfig"
)

Attributes

kms_encryption_config

The AWS Key Management Service ( AWS KMS) encryption key that Amazon S3 uses to encrypt your data.

Link

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

Return type

Union[IResolvable, KMSEncryptionConfigProperty, None]

no_encryption_config

Disables encryption.

For valid values, see the NoEncryptionConfig content for the EncryptionConfiguration data type in the Amazon Kinesis Data Firehose API Reference .

Link

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

Return type

Optional[str]

ExtendedS3DestinationConfigurationProperty

class CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty(*, bucket_arn, role_arn, buffering_hints=None, cloud_watch_logging_options=None, compression_format=None, data_format_conversion_configuration=None, dynamic_partitioning_configuration=None, encryption_configuration=None, error_output_prefix=None, prefix=None, processing_configuration=None, s3_backup_configuration=None, s3_backup_mode=None)

Bases: object

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

Parameters
  • bucket_arn (str) – The Amazon Resource Name (ARN) of the Amazon S3 bucket. For constraints, see ExtendedS3DestinationConfiguration in the Amazon Kinesis Data Firehose API Reference .

  • role_arn (str) –

    The Amazon Resource Name (ARN) of the AWS credentials. For constraints, see ExtendedS3DestinationConfiguration in the Amazon Kinesis Data Firehose API Reference .

  • buffering_hints (Union[IResolvable, BufferingHintsProperty, None]) – The buffering option.

  • cloud_watch_logging_options (Union[IResolvable, CloudWatchLoggingOptionsProperty, None]) – The Amazon CloudWatch logging options for your delivery stream.

  • compression_format (Optional[str]) – The compression format. If no value is specified, the default is UNCOMPRESSED .

  • data_format_conversion_configuration (Union[IResolvable, DataFormatConversionConfigurationProperty, None]) – The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

  • dynamic_partitioning_configuration (Union[IResolvable, DynamicPartitioningConfigurationProperty, None]) – The configuration of the dynamic partitioning mechanism that creates targeted data sets from the streaming data by partitioning it based on partition keys.

  • encryption_configuration (Union[IResolvable, EncryptionConfigurationProperty, None]) – The encryption configuration for the Kinesis Data Firehose delivery stream. The default value is NoEncryption .

  • error_output_prefix (Optional[str]) – 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 .

  • prefix (Optional[str]) –

    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 .

  • processing_configuration (Union[IResolvable, ProcessingConfigurationProperty, None]) – The data processing configuration for the Kinesis Data Firehose delivery stream.

  • s3_backup_configuration (Union[IResolvable, S3DestinationConfigurationProperty, None]) – The configuration for backup in Amazon S3.

  • s3_backup_mode (Optional[str]) – The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can’t update the delivery stream to disable it.

Link

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

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

extended_s3_destination_configuration_property = 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

bucket_arn

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

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

Link

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

Return type

str

buffering_hints

The buffering option.

Link

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

Return type

Union[IResolvable, BufferingHintsProperty, None]

cloud_watch_logging_options

The Amazon CloudWatch logging options for your delivery stream.

Link

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

Return type

Union[IResolvable, CloudWatchLoggingOptionsProperty, None]

compression_format

The compression format.

If no value is specified, the default is UNCOMPRESSED .

Link

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

Return type

Optional[str]

data_format_conversion_configuration

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

Link

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

Return type

Union[IResolvable, DataFormatConversionConfigurationProperty, None]

dynamic_partitioning_configuration

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

Link

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

Return type

Union[IResolvable, DynamicPartitioningConfigurationProperty, None]

encryption_configuration

The encryption configuration for the Kinesis Data Firehose delivery stream.

The default value is NoEncryption .

Link

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

Return type

Union[IResolvable, EncryptionConfigurationProperty, None]

error_output_prefix

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 .

Link

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

Return type

Optional[str]

prefix

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 .

Link

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

Return type

Optional[str]

processing_configuration

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

Link

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

Return type

Union[IResolvable, ProcessingConfigurationProperty, None]

role_arn

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

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

Link

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

Return type

str

s3_backup_configuration

The configuration for backup in Amazon S3.

Link

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

Return type

Union[IResolvable, S3DestinationConfigurationProperty, None]

s3_backup_mode

The Amazon S3 backup mode.

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

Link

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

Return type

Optional[str]

HiveJsonSerDeProperty

class CfnDeliveryStream.HiveJsonSerDeProperty(*, timestamp_formats=None)

Bases: object

The native Hive / HCatalog JsonSerDe.

Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.

Parameters

timestamp_formats (Optional[Sequence[str]]) – Indicates how you want Kinesis Data Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime’s DateTimeFormat format strings. For more information, see Class DateTimeFormat . You can also use the special value millis to parse timestamps in epoch milliseconds. If you don’t specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.

Link

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

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

hive_json_ser_de_property = kinesisfirehose.CfnDeliveryStream.HiveJsonSerDeProperty(
    timestamp_formats=["timestampFormats"]
)

Attributes

timestamp_formats

Indicates how you want Kinesis Data Firehose to parse the date and timestamps that may be present in your input data JSON.

To specify these format strings, follow the pattern syntax of JodaTime’s DateTimeFormat format strings. For more information, see Class DateTimeFormat . You can also use the special value millis to parse timestamps in epoch milliseconds. If you don’t specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-hivejsonserde.html#cfn-kinesisfirehose-deliverystream-hivejsonserde-timestampformats

Return type

Optional[List[str]]

HttpEndpointCommonAttributeProperty

class CfnDeliveryStream.HttpEndpointCommonAttributeProperty(*, attribute_name, attribute_value)

Bases: object

Describes the metadata that’s delivered to the specified HTTP endpoint destination.

Kinesis Firehose supports any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers, including Datadog, MongoDB, and New Relic.

Parameters
  • attribute_name (str) – The name of the HTTP endpoint common attribute.

  • attribute_value (str) – The value of the HTTP endpoint common attribute.

Link

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

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

http_endpoint_common_attribute_property = kinesisfirehose.CfnDeliveryStream.HttpEndpointCommonAttributeProperty(
    attribute_name="attributeName",
    attribute_value="attributeValue"
)

Attributes

attribute_name

The name of the HTTP endpoint common attribute.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointcommonattribute.html#cfn-kinesisfirehose-deliverystream-httpendpointcommonattribute-attributename

Return type

str

attribute_value

The value of the HTTP endpoint common attribute.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointcommonattribute.html#cfn-kinesisfirehose-deliverystream-httpendpointcommonattribute-attributevalue

Return type

str

HttpEndpointConfigurationProperty

class CfnDeliveryStream.HttpEndpointConfigurationProperty(*, url, access_key=None, name=None)

Bases: object

Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.

Kinesis Firehose supports any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers, including Datadog, MongoDB, and New Relic.

Parameters
  • url (str) – The URL of the HTTP endpoint selected as the destination.

  • access_key (Optional[str]) – The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.

  • name (Optional[str]) – The name of the HTTP endpoint selected as the destination.

Link

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

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

http_endpoint_configuration_property = kinesisfirehose.CfnDeliveryStream.HttpEndpointConfigurationProperty(
    url="url",

    # the properties below are optional
    access_key="accessKey",
    name="name"
)

Attributes

access_key

The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-accesskey

Return type

Optional[str]

name

The name of the HTTP endpoint selected as the destination.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-name

Return type

Optional[str]

url

The URL of the HTTP endpoint selected as the destination.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-url

Return type

str

HttpEndpointDestinationConfigurationProperty

class CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty(*, endpoint_configuration, s3_configuration, buffering_hints=None, cloud_watch_logging_options=None, processing_configuration=None, request_configuration=None, retry_options=None, role_arn=None, s3_backup_mode=None)

Bases: object

Describes the configuration of the HTTP endpoint destination.

Kinesis Firehose supports any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers, including Datadog, MongoDB, and New Relic.

Parameters
  • endpoint_configuration (Union[IResolvable, HttpEndpointConfigurationProperty]) – The configuration of the HTTP endpoint selected as the destination.

  • s3_configuration (Union[IResolvable, S3DestinationConfigurationProperty]) – Describes the configuration of a destination in Amazon S3.

  • buffering_hints (Union[IResolvable, BufferingHintsProperty, None]) – The buffering options that can be used before data is delivered to the specified destination. Kinesis Data Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if you specify a value for one of them, you must also provide a value for the other.

  • cloud_watch_logging_options (Union[IResolvable, CloudWatchLoggingOptionsProperty, None]) – Describes the Amazon CloudWatch logging options for your delivery stream.

  • processing_configuration (Union[IResolvable, ProcessingConfigurationProperty, None]) – Describes the data processing configuration.

  • request_configuration (Union[IResolvable, HttpEndpointRequestConfigurationProperty, None]) – The configuration of the request sent to the HTTP endpoint specified as the destination.

  • retry_options (Union[IResolvable, RetryOptionsProperty, None]) – Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn’t receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.

  • role_arn (Optional[str]) – Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.

  • s3_backup_mode (Optional[str]) – Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

Link

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

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

http_endpoint_destination_configuration_property = kinesisfirehose.CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty(
    endpoint_configuration=kinesisfirehose.CfnDeliveryStream.HttpEndpointConfigurationProperty(
        url="url",

        # the properties below are optional
        access_key="accessKey",
        name="name"
    ),
    s3_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"
    ),

    # 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"
    ),
    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"
            )]
        )]
    ),
    request_configuration=kinesisfirehose.CfnDeliveryStream.HttpEndpointRequestConfigurationProperty(
        common_attributes=[kinesisfirehose.CfnDeliveryStream.HttpEndpointCommonAttributeProperty(
            attribute_name="attributeName",
            attribute_value="attributeValue"
        )],
        content_encoding="contentEncoding"
    ),
    retry_options=kinesisfirehose.CfnDeliveryStream.RetryOptionsProperty(
        duration_in_seconds=123
    ),
    role_arn="roleArn",
    s3_backup_mode="s3BackupMode"
)

Attributes

buffering_hints

The buffering options that can be used before data is delivered to the specified destination.

Kinesis Data Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if you specify a value for one of them, you must also provide a value for the other.

Link

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

Return type

Union[IResolvable, BufferingHintsProperty, None]

cloud_watch_logging_options

Describes the Amazon CloudWatch logging options for your delivery stream.

Link

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

Return type

Union[IResolvable, CloudWatchLoggingOptionsProperty, None]

endpoint_configuration

The configuration of the HTTP endpoint selected as the destination.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-endpointconfiguration

Return type

Union[IResolvable, HttpEndpointConfigurationProperty]

processing_configuration

Describes the data processing configuration.

Link

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

Return type

Union[IResolvable, ProcessingConfigurationProperty, None]

request_configuration

The configuration of the request sent to the HTTP endpoint specified as the destination.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-requestconfiguration

Return type

Union[IResolvable, HttpEndpointRequestConfigurationProperty, None]

retry_options

Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn’t receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.

Link

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

Return type

Union[IResolvable, RetryOptionsProperty, None]

role_arn

Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.

Link

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

Return type

Optional[str]

s3_backup_mode

Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination.

You can back up all documents (AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

Link

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

Return type

Optional[str]

s3_configuration

Describes the configuration of a destination in Amazon S3.

Link

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

Return type

Union[IResolvable, S3DestinationConfigurationProperty]

HttpEndpointRequestConfigurationProperty

class CfnDeliveryStream.HttpEndpointRequestConfigurationProperty(*, common_attributes=None, content_encoding=None)

Bases: object

The configuration of the HTTP endpoint request.

Kinesis Firehose supports any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers, including Datadog, MongoDB, and New Relic.

Parameters
  • common_attributes (Union[IResolvable, Sequence[Union[IResolvable, HttpEndpointCommonAttributeProperty]], None]) – Describes the metadata sent to the HTTP endpoint destination.

  • content_encoding (Optional[str]) – Kinesis Data Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation.

Link

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

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

http_endpoint_request_configuration_property = kinesisfirehose.CfnDeliveryStream.HttpEndpointRequestConfigurationProperty(
    common_attributes=[kinesisfirehose.CfnDeliveryStream.HttpEndpointCommonAttributeProperty(
        attribute_name="attributeName",
        attribute_value="attributeValue"
    )],
    content_encoding="contentEncoding"
)

Attributes

common_attributes

Describes the metadata sent to the HTTP endpoint destination.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointrequestconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointrequestconfiguration-commonattributes

Return type

Union[IResolvable, List[Union[IResolvable, HttpEndpointCommonAttributeProperty]], None]

content_encoding

Kinesis Data Firehose uses the content encoding to compress the body of a request before sending the request to the destination.

For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointrequestconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointrequestconfiguration-contentencoding

Return type

Optional[str]

InputFormatConfigurationProperty

class CfnDeliveryStream.InputFormatConfigurationProperty(*, deserializer=None)

Bases: object

Specifies the deserializer you want to use to convert the format of the input data.

This parameter is required if Enabled is set to true.

Parameters

deserializer (Union[IResolvable, DeserializerProperty, None]) – Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.

Link

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

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

input_format_configuration_property = 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
        )
    )
)

Attributes

deserializer

Specifies which deserializer to use.

You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-inputformatconfiguration.html#cfn-kinesisfirehose-deliverystream-inputformatconfiguration-deserializer

Return type

Union[IResolvable, DeserializerProperty, None]

KMSEncryptionConfigProperty

class CfnDeliveryStream.KMSEncryptionConfigProperty(*, awskms_key_arn)

Bases: object

The KMSEncryptionConfig property type specifies the AWS Key Management Service ( AWS KMS) encryption key that Amazon Simple Storage Service (Amazon S3) uses to encrypt data delivered by the Amazon Kinesis Data Firehose (Kinesis Data Firehose) stream.

Parameters

awskms_key_arn (str) – The Amazon Resource Name (ARN) of the AWS KMS encryption key that Amazon S3 uses to encrypt data delivered by the Kinesis Data Firehose stream. The key must belong to the same region as the destination S3 bucket.

Link

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

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

k_mSEncryption_config_property = kinesisfirehose.CfnDeliveryStream.KMSEncryptionConfigProperty(
    awskms_key_arn="awskmsKeyArn"
)

Attributes

awskms_key_arn

The Amazon Resource Name (ARN) of the AWS KMS encryption key that Amazon S3 uses to encrypt data delivered by the Kinesis Data Firehose stream.

The key must belong to the same region as the destination S3 bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kmsencryptionconfig.html#cfn-kinesisfirehose-deliverystream-kmsencryptionconfig-awskmskeyarn

Return type

str

KinesisStreamSourceConfigurationProperty

class CfnDeliveryStream.KinesisStreamSourceConfigurationProperty(*, kinesis_stream_arn, role_arn)

Bases: object

The KinesisStreamSourceConfiguration property type specifies the stream and role Amazon Resource Names (ARNs) for a Kinesis stream used as the source for a delivery stream.

Parameters
  • kinesis_stream_arn (str) – The ARN of the source Kinesis data stream.

  • role_arn (str) – The ARN of the role that provides access to the source Kinesis data stream.

Link

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

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

kinesis_stream_source_configuration_property = kinesisfirehose.CfnDeliveryStream.KinesisStreamSourceConfigurationProperty(
    kinesis_stream_arn="kinesisStreamArn",
    role_arn="roleArn"
)

Attributes

kinesis_stream_arn

The ARN of the source Kinesis data stream.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-kinesisstreamarn

Return type

str

role_arn

The ARN of the role that provides access to the source Kinesis data stream.

Link

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

Return type

str

OpenXJsonSerDeProperty

class CfnDeliveryStream.OpenXJsonSerDeProperty(*, case_insensitive=None, column_to_json_key_mappings=None, convert_dots_in_json_keys_to_underscores=None)

Bases: object

The OpenX SerDe.

Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.

Parameters
  • case_insensitive (Union[bool, IResolvable, None]) – When set to true , which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.

  • column_to_json_key_mappings (Union[IResolvable, Mapping[str, str], None]) – Maps column names to JSON keys that aren’t identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, timestamp is a Hive keyword. If you have a JSON key named timestamp , set this parameter to {"ts": "timestamp"} to map this key to a column named ts .

  • convert_dots_in_json_keys_to_underscores (Union[bool, IResolvable, None]) – When set to true , specifies that the names of the keys include dots and that you want Kinesis Data Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is “a.b”, you can define the column name to be “a_b” when using this option. The default is false .

Link

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

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

open_xJson_ser_de_property = 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
)

Attributes

case_insensitive

When set to true , which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html#cfn-kinesisfirehose-deliverystream-openxjsonserde-caseinsensitive

Return type

Union[bool, IResolvable, None]

column_to_json_key_mappings

Maps column names to JSON keys that aren’t identical to the column names.

This is useful when the JSON contains keys that are Hive keywords. For example, timestamp is a Hive keyword. If you have a JSON key named timestamp , set this parameter to {"ts": "timestamp"} to map this key to a column named ts .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html#cfn-kinesisfirehose-deliverystream-openxjsonserde-columntojsonkeymappings

Return type

Union[IResolvable, Mapping[str, str], None]

convert_dots_in_json_keys_to_underscores

When set to true , specifies that the names of the keys include dots and that you want Kinesis Data Firehose to replace them with underscores.

This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is “a.b”, you can define the column name to be “a_b” when using this option.

The default is false .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html#cfn-kinesisfirehose-deliverystream-openxjsonserde-convertdotsinjsonkeystounderscores

Return type

Union[bool, IResolvable, None]

OrcSerDeProperty

class CfnDeliveryStream.OrcSerDeProperty(*, block_size_bytes=None, bloom_filter_columns=None, bloom_filter_false_positive_probability=None, compression=None, dictionary_key_threshold=None, enable_padding=None, format_version=None, padding_tolerance=None, row_index_stride=None, stripe_size_bytes=None)

Bases: object

A serializer to use for converting data to the ORC format before storing it in Amazon S3.

For more information, see Apache ORC .

Parameters
  • block_size_bytes (Union[int, float, None]) – The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

  • bloom_filter_columns (Optional[Sequence[str]]) – The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null .

  • bloom_filter_false_positive_probability (Union[int, float, None]) – The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.

  • compression (Optional[str]) – The compression code to use over data blocks. The default is SNAPPY .

  • dictionary_key_threshold (Union[int, float, None]) – Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.

  • enable_padding (Union[bool, IResolvable, None]) – Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is false .

  • format_version (Optional[str]) – The version of the file to write. The possible values are V0_11 and V0_12 . The default is V0_12 .

  • padding_tolerance (Union[int, float, None]) – A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size. For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task. Kinesis Data Firehose ignores this parameter when EnablePadding is false .

  • row_index_stride (Union[int, float, None]) – The number of rows between index entries. The default is 10,000 and the minimum is 1,000.

  • stripe_size_bytes (Union[int, float, None]) – The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.

Link

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

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

orc_ser_de_property = 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
)

Attributes

block_size_bytes

The Hadoop Distributed File System (HDFS) block size.

This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-blocksizebytes

Return type

Union[int, float, None]

bloom_filter_columns

The column names for which you want Kinesis Data Firehose to create bloom filters.

The default is null .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-bloomfiltercolumns

Return type

Optional[List[str]]

bloom_filter_false_positive_probability

The Bloom filter false positive probability (FPP).

The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-bloomfilterfalsepositiveprobability

Return type

Union[int, float, None]

compression

The compression code to use over data blocks.

The default is SNAPPY .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-compression

Return type

Optional[str]

dictionary_key_threshold

Represents the fraction of the total number of non-null rows.

To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-dictionarykeythreshold

Return type

Union[int, float, None]

enable_padding

Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries.

This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is false .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-enablepadding

Return type

Union[bool, IResolvable, None]

format_version

The version of the file to write.

The possible values are V0_11 and V0_12 . The default is V0_12 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-formatversion

Return type

Optional[str]

padding_tolerance

A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size.

The default value is 0.05, which means 5 percent of stripe size.

For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.

Kinesis Data Firehose ignores this parameter when EnablePadding is false .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-paddingtolerance

Return type

Union[int, float, None]

row_index_stride

The number of rows between index entries.

The default is 10,000 and the minimum is 1,000.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-rowindexstride

Return type

Union[int, float, None]

stripe_size_bytes

The number of bytes in each stripe.

The default is 64 MiB and the minimum is 8 MiB.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-stripesizebytes

Return type

Union[int, float, None]

OutputFormatConfigurationProperty

class CfnDeliveryStream.OutputFormatConfigurationProperty(*, serializer=None)

Bases: object

Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3.

This parameter is required if Enabled is set to true.

Parameters

serializer (Union[IResolvable, SerializerProperty, None]) – Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.

Link

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

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

output_format_configuration_property = 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"
        )
    )
)

Attributes

serializer

Specifies which serializer to use.

You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-outputformatconfiguration.html#cfn-kinesisfirehose-deliverystream-outputformatconfiguration-serializer

Return type

Union[IResolvable, SerializerProperty, None]

ParquetSerDeProperty

class CfnDeliveryStream.ParquetSerDeProperty(*, block_size_bytes=None, compression=None, enable_dictionary_compression=None, max_padding_bytes=None, page_size_bytes=None, writer_version=None)

Bases: object

A serializer to use for converting data to the Parquet format before storing it in Amazon S3.

For more information, see Apache Parquet .

Parameters
  • block_size_bytes (Union[int, float, None]) – The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

  • compression (Optional[str]) – The compression code to use over data blocks. The possible values are UNCOMPRESSED , SNAPPY , and GZIP , with the default being SNAPPY . Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed.

  • enable_dictionary_compression (Union[bool, IResolvable, None]) – Indicates whether to enable dictionary compression.

  • max_padding_bytes (Union[int, float, None]) – The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0.

  • page_size_bytes (Union[int, float, None]) – The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.

  • writer_version (Optional[str]) – Indicates the version of row format to output. The possible values are V1 and V2 . The default is V1 .

Link

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

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

parquet_ser_de_property = kinesisfirehose.CfnDeliveryStream.ParquetSerDeProperty(
    block_size_bytes=123,
    compression="compression",
    enable_dictionary_compression=False,
    max_padding_bytes=123,
    page_size_bytes=123,
    writer_version="writerVersion"
)

Attributes

block_size_bytes

The Hadoop Distributed File System (HDFS) block size.

This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-blocksizebytes

Return type

Union[int, float, None]

compression

The compression code to use over data blocks.

The possible values are UNCOMPRESSED , SNAPPY , and GZIP , with the default being SNAPPY . Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-compression

Return type

Optional[str]

enable_dictionary_compression

Indicates whether to enable dictionary compression.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-enabledictionarycompression

Return type

Union[bool, IResolvable, None]

max_padding_bytes

The maximum amount of padding to apply.

This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-maxpaddingbytes

Return type

Union[int, float, None]

page_size_bytes

The Parquet page size.

Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-pagesizebytes

Return type

Union[int, float, None]

writer_version

Indicates the version of row format to output.

The possible values are V1 and V2 . The default is V1 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-writerversion

Return type

Optional[str]

ProcessingConfigurationProperty

class CfnDeliveryStream.ProcessingConfigurationProperty(*, enabled=None, processors=None)

Bases: object

The ProcessingConfiguration property configures data processing for an Amazon Kinesis Data Firehose delivery stream.

Parameters
Link

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

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

processing_configuration_property = 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"
        )]
    )]
)

Attributes

enabled

Indicates whether data processing is enabled (true) or disabled (false).

Link

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

Return type

Union[bool, IResolvable, None]

processors

The data processors.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, ProcessorProperty]], None]

ProcessorParameterProperty

class CfnDeliveryStream.ProcessorParameterProperty(*, parameter_name, parameter_value)

Bases: object

The ProcessorParameter property specifies a processor parameter in a data processor for an Amazon Kinesis Data Firehose delivery stream.

Parameters
  • parameter_name (str) – The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries , 60 for the BufferIntervalInSeconds , and 3 for the BufferSizeInMBs .

  • parameter_value (str) – The parameter value.

Link

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

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

processor_parameter_property = kinesisfirehose.CfnDeliveryStream.ProcessorParameterProperty(
    parameter_name="parameterName",
    parameter_value="parameterValue"
)

Attributes

parameter_name

The name of the parameter.

Currently the following default values are supported: 3 for NumberOfRetries , 60 for the BufferIntervalInSeconds , and 3 for the BufferSizeInMBs .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processorparameter.html#cfn-kinesisfirehose-deliverystream-processorparameter-parametername

Return type

str

parameter_value

The parameter value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processorparameter.html#cfn-kinesisfirehose-deliverystream-processorparameter-parametervalue

Return type

str

ProcessorProperty

class CfnDeliveryStream.ProcessorProperty(*, type, parameters=None)

Bases: object

The Processor property specifies a data processor for an Amazon Kinesis Data Firehose delivery stream.

Parameters
Link

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

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

processor_property = kinesisfirehose.CfnDeliveryStream.ProcessorProperty(
    type="type",

    # the properties below are optional
    parameters=[kinesisfirehose.CfnDeliveryStream.ProcessorParameterProperty(
        parameter_name="parameterName",
        parameter_value="parameterValue"
    )]
)

Attributes

parameters

The processor parameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processor.html#cfn-kinesisfirehose-deliverystream-processor-parameters

Return type

Union[IResolvable, List[Union[IResolvable, ProcessorParameterProperty]], None]

type

The type of processor.

Valid values: Lambda .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processor.html#cfn-kinesisfirehose-deliverystream-processor-type

Return type

str

RedshiftDestinationConfigurationProperty

class CfnDeliveryStream.RedshiftDestinationConfigurationProperty(*, cluster_jdbcurl, copy_command, password, role_arn, s3_configuration, username, cloud_watch_logging_options=None, processing_configuration=None, retry_options=None, s3_backup_configuration=None, s3_backup_mode=None)

Bases: object

The RedshiftDestinationConfiguration property type specifies an Amazon Redshift cluster to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

Parameters
  • cluster_jdbcurl (str) – The connection string that Kinesis Data Firehose uses to connect to the Amazon Redshift cluster.

  • copy_command (Union[IResolvable, CopyCommandProperty]) – Configures the Amazon Redshift COPY command that Kinesis Data Firehose uses to load data into the cluster from the Amazon S3 bucket.

  • password (str) – The password for the Amazon Redshift user that you specified in the Username property.

  • role_arn (str) – The ARN of the AWS Identity and Access Management (IAM) role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS (if you enable data encryption). For more information, see Grant Kinesis Data Firehose Access to an Amazon Redshift Destination in the Amazon Kinesis Data Firehose Developer Guide .

  • s3_configuration (Union[IResolvable, S3DestinationConfigurationProperty]) – The S3 bucket where Kinesis Data Firehose first delivers data. After the data is in the bucket, Kinesis Data Firehose uses the COPY command to load the data into the Amazon Redshift cluster. For the Amazon S3 bucket’s compression format, don’t specify SNAPPY or ZIP because the Amazon Redshift COPY command doesn’t support them.

  • username (str) – The Amazon Redshift user that has permission to access the Amazon Redshift cluster. This user must have INSERT privileges for copying data from the Amazon S3 bucket to the cluster.

  • cloud_watch_logging_options (Union[IResolvable, CloudWatchLoggingOptionsProperty, None]) – The CloudWatch logging options for your delivery stream.

  • processing_configuration (Union[IResolvable, ProcessingConfigurationProperty, None]) – The data processing configuration for the Kinesis Data Firehose delivery stream.

  • retry_options (Union[IResolvable, RedshiftRetryOptionsProperty, None]) – The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

  • s3_backup_configuration (Union[IResolvable, S3DestinationConfigurationProperty, None]) – The configuration for backup in Amazon S3.

  • s3_backup_mode (Optional[str]) – The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can’t update the delivery stream to disable it.

Link

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

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

redshift_destination_configuration_property = kinesisfirehose.CfnDeliveryStream.RedshiftDestinationConfigurationProperty(
    cluster_jdbcurl="clusterJdbcurl",
    copy_command=kinesisfirehose.CfnDeliveryStream.CopyCommandProperty(
        data_table_name="dataTableName",

        # the properties below are optional
        copy_options="copyOptions",
        data_table_columns="dataTableColumns"
    ),
    password="password",
    role_arn="roleArn",
    s3_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"
    ),
    username="username",

    # the properties below are optional
    cloud_watch_logging_options=kinesisfirehose.CfnDeliveryStream.CloudWatchLoggingOptionsProperty(
        enabled=False,
        log_group_name="logGroupName",
        log_stream_name="logStreamName"
    ),
    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"
            )]
        )]
    ),
    retry_options=kinesisfirehose.CfnDeliveryStream.RedshiftRetryOptionsProperty(
        duration_in_seconds=123
    ),
    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

cloud_watch_logging_options

The CloudWatch logging options for your delivery stream.

Link

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

Return type

Union[IResolvable, CloudWatchLoggingOptionsProperty, None]

cluster_jdbcurl

The connection string that Kinesis Data Firehose uses to connect to the Amazon Redshift cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-clusterjdbcurl

Return type

str

copy_command

Configures the Amazon Redshift COPY command that Kinesis Data Firehose uses to load data into the cluster from the Amazon S3 bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-copycommand

Return type

Union[IResolvable, CopyCommandProperty]

password

The password for the Amazon Redshift user that you specified in the Username property.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-password

Return type

str

processing_configuration

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

Link

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

Return type

Union[IResolvable, ProcessingConfigurationProperty, None]

retry_options

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.

Default value is 3600 (60 minutes).

Link

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

Return type

Union[IResolvable, RedshiftRetryOptionsProperty, None]

role_arn

The ARN of the AWS Identity and Access Management (IAM) role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS (if you enable data encryption).

For more information, see Grant Kinesis Data Firehose Access to an Amazon Redshift Destination in the Amazon Kinesis Data Firehose Developer Guide .

Link

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

Return type

str

s3_backup_configuration

The configuration for backup in Amazon S3.

Link

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

Return type

Union[IResolvable, S3DestinationConfigurationProperty, None]

s3_backup_mode

The Amazon S3 backup mode.

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

Link

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

Return type

Optional[str]

s3_configuration

The S3 bucket where Kinesis Data Firehose first delivers data.

After the data is in the bucket, Kinesis Data Firehose uses the COPY command to load the data into the Amazon Redshift cluster. For the Amazon S3 bucket’s compression format, don’t specify SNAPPY or ZIP because the Amazon Redshift COPY command doesn’t support them.

Link

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

Return type

Union[IResolvable, S3DestinationConfigurationProperty]

username

The Amazon Redshift user that has permission to access the Amazon Redshift cluster.

This user must have INSERT privileges for copying data from the Amazon S3 bucket to the cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-username

Return type

str

RedshiftRetryOptionsProperty

class CfnDeliveryStream.RedshiftRetryOptionsProperty(*, duration_in_seconds=None)

Bases: object

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.

Parameters

duration_in_seconds (Union[int, float, None]) – The length of time during which Kinesis Data Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Kinesis Data Firehose does not retry if the value of DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.

Link

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

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

redshift_retry_options_property = kinesisfirehose.CfnDeliveryStream.RedshiftRetryOptionsProperty(
    duration_in_seconds=123
)

Attributes

duration_in_seconds

The length of time during which Kinesis Data Firehose retries delivery after a failure, starting from the initial request and including the first attempt.

The default value is 3600 seconds (60 minutes). Kinesis Data Firehose does not retry if the value of DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftretryoptions.html#cfn-kinesisfirehose-deliverystream-redshiftretryoptions-durationinseconds

Return type

Union[int, float, None]

RetryOptionsProperty

class CfnDeliveryStream.RetryOptionsProperty(*, duration_in_seconds=None)

Bases: object

Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn’t receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.

Kinesis Firehose supports any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers, including Datadog, MongoDB, and New Relic.

Parameters

duration_in_seconds (Union[int, float, None]) – The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to the custom destination via HTTPS endpoint fails. It doesn’t include the periods during which Kinesis Data Firehose waits for acknowledgment from the specified destination after each attempt.

Link

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

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

retry_options_property = kinesisfirehose.CfnDeliveryStream.RetryOptionsProperty(
    duration_in_seconds=123
)

Attributes

duration_in_seconds

The total amount of time that Kinesis Data Firehose spends on retries.

This duration starts after the initial attempt to send data to the custom destination via HTTPS endpoint fails. It doesn’t include the periods during which Kinesis Data Firehose waits for acknowledgment from the specified destination after each attempt.

Link

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

Return type

Union[int, float, None]

S3DestinationConfigurationProperty

class CfnDeliveryStream.S3DestinationConfigurationProperty(*, bucket_arn, role_arn, buffering_hints=None, cloud_watch_logging_options=None, compression_format=None, encryption_configuration=None, error_output_prefix=None, prefix=None)

Bases: object

The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

Parameters
  • bucket_arn (str) – The Amazon Resource Name (ARN) of the Amazon S3 bucket to send data to.

  • role_arn (str) – The ARN of an AWS Identity and Access Management (IAM) role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS (if you enable data encryption). For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide .

  • buffering_hints (Union[IResolvable, BufferingHintsProperty, None]) – Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon S3 bucket.

  • cloud_watch_logging_options (Union[IResolvable, CloudWatchLoggingOptionsProperty, None]) – The CloudWatch logging options for your delivery stream.

  • compression_format (Optional[str]) – The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket. For valid values, see the CompressionFormat content for the S3DestinationConfiguration data type in the Amazon Kinesis Data Firehose API Reference .

  • encryption_configuration (Union[IResolvable, EncryptionConfigurationProperty, None]) – Configures Amazon Simple Storage Service (Amazon S3) server-side encryption. Kinesis Data Firehose uses AWS Key Management Service ( AWS KMS) to encrypt the data that it delivers to your Amazon S3 bucket.

  • error_output_prefix (Optional[str]) –

    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 .

  • prefix (Optional[str]) – A prefix that Kinesis Data Firehose adds to the files that it delivers to the Amazon S3 bucket. The prefix helps you identify the files that Kinesis Data Firehose delivered.

Link

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

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

s3_destination_configuration_property = 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"
)

Attributes

bucket_arn

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

Link

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

Return type

str

buffering_hints

Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon S3 bucket.

Link

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

Return type

Union[IResolvable, BufferingHintsProperty, None]

cloud_watch_logging_options

The CloudWatch logging options for your delivery stream.

Link

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

Return type

Union[IResolvable, CloudWatchLoggingOptionsProperty, None]

compression_format

The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.

For valid values, see the CompressionFormat content for the S3DestinationConfiguration data type in the Amazon Kinesis Data Firehose API Reference .

Link

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

Return type

Optional[str]

encryption_configuration

Configures Amazon Simple Storage Service (Amazon S3) server-side encryption.

Kinesis Data Firehose uses AWS Key Management Service ( AWS KMS) to encrypt the data that it delivers to your Amazon S3 bucket.

Link

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

Return type

Union[IResolvable, EncryptionConfigurationProperty, None]

error_output_prefix

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 .

Link

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

Return type

Optional[str]

prefix

A prefix that Kinesis Data Firehose adds to the files that it delivers to the Amazon S3 bucket.

The prefix helps you identify the files that Kinesis Data Firehose delivered.

Link

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

Return type

Optional[str]

role_arn

The ARN of an AWS Identity and Access Management (IAM) role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS (if you enable data encryption).

For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide .

Link

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

Return type

str

SchemaConfigurationProperty

class CfnDeliveryStream.SchemaConfigurationProperty(*, catalog_id=None, database_name=None, region=None, role_arn=None, table_name=None, version_id=None)

Bases: object

Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3.

This parameter is required if Enabled is set to true.

Parameters
  • catalog_id (Optional[str]) – The ID of the AWS Glue Data Catalog. If you don’t supply this, the AWS account ID is used by default.

  • database_name (Optional[str]) – Specifies the name of the AWS Glue database that contains the schema for the output data. .. epigraph:: If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

  • region (Optional[str]) – If you don’t specify an AWS Region, the default is the current Region.

  • role_arn (Optional[str]) – The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren’t allowed. .. epigraph:: If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

  • table_name (Optional[str]) – Specifies the AWS Glue table that contains the column information that constitutes your data schema. .. epigraph:: If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

  • version_id (Optional[str]) – Specifies the table version for the output data schema. If you don’t specify this version ID, or if you set it to LATEST , Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Link

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

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

schema_configuration_property = kinesisfirehose.CfnDeliveryStream.SchemaConfigurationProperty(
    catalog_id="catalogId",
    database_name="databaseName",
    region="region",
    role_arn="roleArn",
    table_name="tableName",
    version_id="versionId"
)

Attributes

catalog_id

The ID of the AWS Glue Data Catalog.

If you don’t supply this, the AWS account ID is used by default.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-catalogid

Return type

Optional[str]

database_name

Specifies the name of the AWS Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-databasename

Return type

Optional[str]

region

If you don’t specify an AWS Region, the default is the current Region.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-region

Return type

Optional[str]

role_arn

The role that Kinesis Data Firehose can use to access AWS Glue.

This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren’t allowed. .. epigraph:

If the ``SchemaConfiguration`` request parameter is used as part of invoking the ``CreateDeliveryStream`` API, then the ``RoleARN`` property is required and its value must be specified.
Link

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

Return type

Optional[str]

table_name

Specifies the AWS Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-tablename

Return type

Optional[str]

version_id

Specifies the table version for the output data schema.

If you don’t specify this version ID, or if you set it to LATEST , Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-versionid

Return type

Optional[str]

SerializerProperty

class CfnDeliveryStream.SerializerProperty(*, orc_ser_de=None, parquet_ser_de=None)

Bases: object

The serializer that you want Kinesis Data Firehose to use to convert data to the target format before writing it to Amazon S3.

Kinesis Data Firehose supports two types of serializers: the ORC SerDe and the Parquet SerDe .

Parameters
Link

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

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

serializer_property = 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"
    )
)

Attributes

orc_ser_de

A serializer to use for converting data to the ORC format before storing it in Amazon S3.

For more information, see Apache ORC .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-serializer.html#cfn-kinesisfirehose-deliverystream-serializer-orcserde

Return type

Union[IResolvable, OrcSerDeProperty, None]

parquet_ser_de

A serializer to use for converting data to the Parquet format before storing it in Amazon S3.

For more information, see Apache Parquet .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-serializer.html#cfn-kinesisfirehose-deliverystream-serializer-parquetserde

Return type

Union[IResolvable, ParquetSerDeProperty, None]

SplunkDestinationConfigurationProperty

class CfnDeliveryStream.SplunkDestinationConfigurationProperty(*, hec_endpoint, hec_endpoint_type, hec_token, s3_configuration, cloud_watch_logging_options=None, hec_acknowledgment_timeout_in_seconds=None, processing_configuration=None, retry_options=None, s3_backup_mode=None)

Bases: object

The SplunkDestinationConfiguration property type specifies the configuration of a destination in Splunk for a Kinesis Data Firehose delivery stream.

Parameters
  • hec_endpoint (str) – The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

  • hec_endpoint_type (str) – This type can be either Raw or Event .

  • hec_token (str) – This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

  • s3_configuration (Union[IResolvable, S3DestinationConfigurationProperty]) – The configuration for the backup Amazon S3 location.

  • cloud_watch_logging_options (Union[IResolvable, CloudWatchLoggingOptionsProperty, None]) – The Amazon CloudWatch logging options for your delivery stream.

  • hec_acknowledgment_timeout_in_seconds (Union[int, float, None]) – The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.

  • processing_configuration (Union[IResolvable, ProcessingConfigurationProperty, None]) – The data processing configuration.

  • retry_options (Union[IResolvable, SplunkRetryOptionsProperty, None]) – The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn’t receive an acknowledgment of receipt from Splunk.

  • s3_backup_mode (Optional[str]) – Defines how documents should be delivered to Amazon S3. When set to FailedEventsOnly , Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents , Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly . You can update this backup mode from FailedEventsOnly to AllEvents . You can’t update it from AllEvents to FailedEventsOnly .

Link

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

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

splunk_destination_configuration_property = kinesisfirehose.CfnDeliveryStream.SplunkDestinationConfigurationProperty(
    hec_endpoint="hecEndpoint",
    hec_endpoint_type="hecEndpointType",
    hec_token="hecToken",
    s3_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"
    ),

    # the properties below are optional
    cloud_watch_logging_options=kinesisfirehose.CfnDeliveryStream.CloudWatchLoggingOptionsProperty(
        enabled=False,
        log_group_name="logGroupName",
        log_stream_name="logStreamName"
    ),
    hec_acknowledgment_timeout_in_seconds=123,
    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"
            )]
        )]
    ),
    retry_options=kinesisfirehose.CfnDeliveryStream.SplunkRetryOptionsProperty(
        duration_in_seconds=123
    ),
    s3_backup_mode="s3BackupMode"
)

Attributes

cloud_watch_logging_options

The Amazon CloudWatch logging options for your delivery stream.

Link

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

Return type

Union[IResolvable, CloudWatchLoggingOptionsProperty, None]

hec_acknowledgment_timeout_in_seconds

The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data.

At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecacknowledgmenttimeoutinseconds

Return type

Union[int, float, None]

hec_endpoint

The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpoint

Return type

str

hec_endpoint_type

This type can be either Raw or Event .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpointtype

Return type

str

hec_token

This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hectoken

Return type

str

processing_configuration

The data processing configuration.

Link

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

Return type

Union[IResolvable, ProcessingConfigurationProperty, None]

retry_options

The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn’t receive an acknowledgment of receipt from Splunk.

Link

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

Return type

Union[IResolvable, SplunkRetryOptionsProperty, None]

s3_backup_mode

Defines how documents should be delivered to Amazon S3.

When set to FailedEventsOnly , Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents , Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly .

You can update this backup mode from FailedEventsOnly to AllEvents . You can’t update it from AllEvents to FailedEventsOnly .

Link

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

Return type

Optional[str]

s3_configuration

The configuration for the backup Amazon S3 location.

Link

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

Return type

Union[IResolvable, S3DestinationConfigurationProperty]

SplunkRetryOptionsProperty

class CfnDeliveryStream.SplunkRetryOptionsProperty(*, duration_in_seconds=None)

Bases: object

The SplunkRetryOptions property type specifies retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk or if it doesn’t receive an acknowledgment from Splunk.

Parameters

duration_in_seconds (Union[int, float, None]) – The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn’t include the periods during which Kinesis Data Firehose waits for acknowledgment from Splunk after each attempt.

Link

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

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

splunk_retry_options_property = kinesisfirehose.CfnDeliveryStream.SplunkRetryOptionsProperty(
    duration_in_seconds=123
)

Attributes

duration_in_seconds

The total amount of time that Kinesis Data Firehose spends on retries.

This duration starts after the initial attempt to send data to Splunk fails. It doesn’t include the periods during which Kinesis Data Firehose waits for acknowledgment from Splunk after each attempt.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkretryoptions.html#cfn-kinesisfirehose-deliverystream-splunkretryoptions-durationinseconds

Return type

Union[int, float, None]

VpcConfigurationProperty

class CfnDeliveryStream.VpcConfigurationProperty(*, role_arn, security_group_ids, subnet_ids)

Bases: object

The details of the VPC of the Amazon ES destination.

Parameters
  • role_arn (str) – The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions: - ec2:DescribeVpcs - ec2:DescribeVpcAttribute - ec2:DescribeSubnets - ec2:DescribeSecurityGroups - ec2:DescribeNetworkInterfaces - ec2:CreateNetworkInterface - ec2:CreateNetworkInterfacePermission - ec2:DeleteNetworkInterface If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can’t scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.

  • security_group_ids (Sequence[str]) – The IDs of the security groups that you want Kinesis Data Firehose to use when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain’s security group. Also ensure that the Amazon ES domain’s security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic.

  • subnet_ids (Sequence[str]) – The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs. The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here.

Link

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

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

vpc_configuration_property = kinesisfirehose.CfnDeliveryStream.VpcConfigurationProperty(
    role_arn="roleArn",
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"]
)

Attributes

role_arn

The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC.

You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:

  • ec2:DescribeVpcs

  • ec2:DescribeVpcAttribute

  • ec2:DescribeSubnets

  • ec2:DescribeSecurityGroups

  • ec2:DescribeNetworkInterfaces

  • ec2:CreateNetworkInterface

  • ec2:CreateNetworkInterfacePermission

  • ec2:DeleteNetworkInterface

If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can’t scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.

Link

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

Return type

str

security_group_ids

The IDs of the security groups that you want Kinesis Data Firehose to use when it creates ENIs in the VPC of the Amazon ES destination.

You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain’s security group. Also ensure that the Amazon ES domain’s security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-vpcconfiguration.html#cfn-kinesisfirehose-deliverystream-vpcconfiguration-securitygroupids

Return type

List[str]

subnet_ids

The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the Amazon ES destination.

Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.

The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-vpcconfiguration.html#cfn-kinesisfirehose-deliverystream-vpcconfiguration-subnetids

Return type

List[str]