[ aws . firehose ]

describe-delivery-stream

Description

Describes the specified delivery stream and its status. For example, after your delivery stream is created, call DescribeDeliveryStream to see whether the delivery stream is ACTIVE and therefore ready for data to be sent to it.

If the status of a delivery stream is CREATING_FAILED , this status doesn’t change, and you can’t invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. If the status is DELETING_FAILED , you can force deletion by invoking DeleteDeliveryStream again but with DeleteDeliveryStreamInput$AllowForceDelete set to true.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-delivery-stream
--delivery-stream-name <value>
[--limit <value>]
[--exclusive-start-destination-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--delivery-stream-name (string)

The name of the delivery stream.

--limit (integer)

The limit on the number of destinations to return. You can have one destination per delivery stream.

--exclusive-start-destination-id (string)

The ID of the destination to start returning the destination information. Kinesis Data Firehose supports one destination per delivery stream.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

DeliveryStreamDescription -> (structure)

Information about the delivery stream.

DeliveryStreamName -> (string)

The name of the delivery stream.

DeliveryStreamARN -> (string)

The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

DeliveryStreamStatus -> (string)

The status of the delivery stream. If the status of a delivery stream is CREATING_FAILED , this status doesn’t change, and you can’t invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.

FailureDescription -> (structure)

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream , DeleteDeliveryStream , StartDeliveryStreamEncryption , StopDeliveryStreamEncryption .

Type -> (string)

The type of error that caused the failure.

Details -> (string)

A message providing details about the error that caused the failure.

DeliveryStreamEncryptionConfiguration -> (structure)

Indicates the server-side encryption (SSE) status for the delivery stream.

KeyARN -> (string)

If KeyType is CUSTOMER_MANAGED_CMK , this field contains the ARN of the customer managed CMK. If KeyType is AWS_OWNED_CMK , DeliveryStreamEncryptionConfiguration doesn’t contain a value for KeyARN .

KeyType -> (string)

Indicates the type of customer master key (CMK) that is used for encryption. The default setting is AWS_OWNED_CMK . For more information about CMKs, see Customer Master Keys (CMKs) .

Status -> (string)

This is the server-side encryption (SSE) status for the delivery stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption . If this status is ENABLING_FAILED or DISABLING_FAILED , it is the status of the most recent attempt to enable or disable SSE, respectively.

FailureDescription -> (structure)

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream , DeleteDeliveryStream , StartDeliveryStreamEncryption , StopDeliveryStreamEncryption .

Type -> (string)

The type of error that caused the failure.

Details -> (string)

A message providing details about the error that caused the failure.

DeliveryStreamType -> (string)

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.

VersionId -> (string)

Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.

CreateTimestamp -> (timestamp)

The date and time that the delivery stream was created.

LastUpdateTimestamp -> (timestamp)

The date and time that the delivery stream was last updated.

Source -> (structure)

If the DeliveryStreamType parameter is KinesisStreamAsSource , a SourceDescription object describing the source Kinesis data stream.

KinesisStreamSourceDescription -> (structure)

The KinesisStreamSourceDescription value for the source Kinesis data stream.

KinesisStreamARN -> (string)

The Amazon Resource Name (ARN) of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format .

RoleARN -> (string)

The ARN of the role used by the source Kinesis data stream. For more information, see AWS Identity and Access Management (IAM) ARN Format .

DeliveryStartTimestamp -> (timestamp)

Kinesis Data Firehose starts retrieving records from the Kinesis data stream starting with this timestamp.

Destinations -> (list)

The destinations.

(structure)

Describes the destination for a delivery stream.

DestinationId -> (string)

The ID of the destination.

S3DestinationDescription -> (structure)

[Deprecated] The destination in Amazon S3.

RoleARN -> (string)

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

BucketARN -> (string)

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

Prefix -> (string)

The “YYYY/MM/DD/HH” time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects .

ErrorOutputPrefix -> (string)

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 .

BufferingHints -> (structure)

The buffering option. If no value is specified, BufferingHints object default values are used.

SizeInMBs -> (integer)

Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds , and vice versa.

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 MiB/sec, the value should be 10 MiB or higher.

IntervalInSeconds -> (integer)

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs , and vice versa.

CompressionFormat -> (string)

The compression format. If no value is specified, the default is UNCOMPRESSED .

EncryptionConfiguration -> (structure)

The encryption configuration. If no value is specified, the default is no encryption.

NoEncryptionConfig -> (string)

Specifically override existing encryption information to ensure that no encryption is used.

KMSEncryptionConfig -> (structure)

The encryption key.

AWSKMSKeyARN -> (string)

The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

CloudWatchLoggingOptions -> (structure)

The Amazon CloudWatch logging options for your delivery stream.

Enabled -> (boolean)

Enables or disables CloudWatch logging.

LogGroupName -> (string)

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

LogStreamName -> (string)

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

ExtendedS3DestinationDescription -> (structure)

The destination in Amazon S3.

RoleARN -> (string)

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

BucketARN -> (string)

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

Prefix -> (string)

The “YYYY/MM/DD/HH” time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects .

ErrorOutputPrefix -> (string)

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 .

BufferingHints -> (structure)

The buffering option.

SizeInMBs -> (integer)

Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds , and vice versa.

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 MiB/sec, the value should be 10 MiB or higher.

IntervalInSeconds -> (integer)

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs , and vice versa.

CompressionFormat -> (string)

The compression format. If no value is specified, the default is UNCOMPRESSED .

EncryptionConfiguration -> (structure)

The encryption configuration. If no value is specified, the default is no encryption.

NoEncryptionConfig -> (string)

Specifically override existing encryption information to ensure that no encryption is used.

KMSEncryptionConfig -> (structure)

The encryption key.

AWSKMSKeyARN -> (string)

The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

CloudWatchLoggingOptions -> (structure)

The Amazon CloudWatch logging options for your delivery stream.

Enabled -> (boolean)

Enables or disables CloudWatch logging.

LogGroupName -> (string)

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

LogStreamName -> (string)

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

ProcessingConfiguration -> (structure)

The data processing configuration.

Enabled -> (boolean)

Enables or disables data processing.

Processors -> (list)

The data processors.

(structure)

Describes a data processor.

Type -> (string)

The type of processor.

Parameters -> (list)

The processor parameters.

(structure)

Describes the processor parameter.

ParameterName -> (string)

The name of the parameter.

ParameterValue -> (string)

The parameter value.

S3BackupMode -> (string)

The Amazon S3 backup mode.

S3BackupDescription -> (structure)

The configuration for backup in Amazon S3.

RoleARN -> (string)

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

BucketARN -> (string)

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

Prefix -> (string)

The “YYYY/MM/DD/HH” time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects .

ErrorOutputPrefix -> (string)

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 .

BufferingHints -> (structure)

The buffering option. If no value is specified, BufferingHints object default values are used.

SizeInMBs -> (integer)

Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds , and vice versa.

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 MiB/sec, the value should be 10 MiB or higher.

IntervalInSeconds -> (integer)

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs , and vice versa.

CompressionFormat -> (string)

The compression format. If no value is specified, the default is UNCOMPRESSED .

EncryptionConfiguration -> (structure)

The encryption configuration. If no value is specified, the default is no encryption.

NoEncryptionConfig -> (string)

Specifically override existing encryption information to ensure that no encryption is used.

KMSEncryptionConfig -> (structure)

The encryption key.

AWSKMSKeyARN -> (string)

The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

CloudWatchLoggingOptions -> (structure)

The Amazon CloudWatch logging options for your delivery stream.

Enabled -> (boolean)

Enables or disables CloudWatch logging.

LogGroupName -> (string)

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

LogStreamName -> (string)

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

DataFormatConversionConfiguration -> (structure)

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

SchemaConfiguration -> (structure)

Specifies the AWS Glue Data Catalog table that contains the column information. This parameter is required if Enabled is set to true.

RoleARN -> (string)

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.

CatalogId -> (string)

The ID of the AWS Glue Data Catalog. If you don’t supply this, the AWS account ID is used by default.

DatabaseName -> (string)

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

TableName -> (string)

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

Region -> (string)

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

VersionId -> (string)

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.

InputFormatConfiguration -> (structure)

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.

Deserializer -> (structure)

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.

OpenXJsonSerDe -> (structure)

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.

ConvertDotsInJsonKeysToUnderscores -> (boolean)

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 .

CaseInsensitive -> (boolean)

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

ColumnToJsonKeyMappings -> (map)

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 .

key -> (string)

value -> (string)

HiveJsonSerDe -> (structure)

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.

TimestampFormats -> (list)

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.

(string)

OutputFormatConfiguration -> (structure)

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.

Serializer -> (structure)

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.

ParquetSerDe -> (structure)

A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet .

BlockSizeBytes -> (integer)

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.

PageSizeBytes -> (integer)

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.

Compression -> (string)

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.

EnableDictionaryCompression -> (boolean)

Indicates whether to enable dictionary compression.

MaxPaddingBytes -> (integer)

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.

WriterVersion -> (string)

Indicates the version of row format to output. The possible values are V1 and V2 . The default is V1 .

OrcSerDe -> (structure)

A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC .

StripeSizeBytes -> (integer)

The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.

BlockSizeBytes -> (integer)

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.

RowIndexStride -> (integer)

The number of rows between index entries. The default is 10,000 and the minimum is 1,000.

EnablePadding -> (boolean)

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 .

PaddingTolerance -> (double)

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 OrcSerDe$EnablePadding is false .

Compression -> (string)

The compression code to use over data blocks. The default is SNAPPY .

BloomFilterColumns -> (list)

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

(string)

BloomFilterFalsePositiveProbability -> (double)

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.

DictionaryKeyThreshold -> (double)

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.

FormatVersion -> (string)

The version of the file to write. The possible values are V0_11 and V0_12 . The default is V0_12 .

Enabled -> (boolean)

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

RedshiftDestinationDescription -> (structure)

The destination in Amazon Redshift.

RoleARN -> (string)

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

ClusterJDBCURL -> (string)

The database connection string.

CopyCommand -> (structure)

The COPY command.

DataTableName -> (string)

The name of the target table. The table must already exist in the database.

DataTableColumns -> (string)

A comma-separated list of column names.

CopyOptions -> (string)

Optional parameters to use with the Amazon Redshift COPY command. For more information, see the “Optional Parameters” section of Amazon Redshift COPY command . Some possible examples that would apply to Kinesis Data Firehose are as follows:

delimiter '\t' lzop; - fields are delimited with “t” (TAB character) and compressed using lzop.

delimiter '|' - fields are delimited with “|” (this is the default delimiter).

delimiter '|' escape - the delimiter should be escaped.

fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

For more examples, see Amazon Redshift COPY command examples .

Username -> (string)

The name of the user.

RetryOptions -> (structure)

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

DurationInSeconds -> (integer)

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.

S3DestinationDescription -> (structure)

The Amazon S3 destination.

RoleARN -> (string)

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

BucketARN -> (string)

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

Prefix -> (string)

The “YYYY/MM/DD/HH” time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects .

ErrorOutputPrefix -> (string)

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 .

BufferingHints -> (structure)

The buffering option. If no value is specified, BufferingHints object default values are used.

SizeInMBs -> (integer)

Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds , and vice versa.

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 MiB/sec, the value should be 10 MiB or higher.

IntervalInSeconds -> (integer)

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs , and vice versa.

CompressionFormat -> (string)

The compression format. If no value is specified, the default is UNCOMPRESSED .

EncryptionConfiguration -> (structure)

The encryption configuration. If no value is specified, the default is no encryption.

NoEncryptionConfig -> (string)

Specifically override existing encryption information to ensure that no encryption is used.

KMSEncryptionConfig -> (structure)

The encryption key.

AWSKMSKeyARN -> (string)

The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

CloudWatchLoggingOptions -> (structure)

The Amazon CloudWatch logging options for your delivery stream.

Enabled -> (boolean)

Enables or disables CloudWatch logging.

LogGroupName -> (string)

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

LogStreamName -> (string)

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

ProcessingConfiguration -> (structure)

The data processing configuration.

Enabled -> (boolean)

Enables or disables data processing.

Processors -> (list)

The data processors.

(structure)

Describes a data processor.

Type -> (string)

The type of processor.

Parameters -> (list)

The processor parameters.

(structure)

Describes the processor parameter.

ParameterName -> (string)

The name of the parameter.

ParameterValue -> (string)

The parameter value.

S3BackupMode -> (string)

The Amazon S3 backup mode.

S3BackupDescription -> (structure)

The configuration for backup in Amazon S3.

RoleARN -> (string)

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

BucketARN -> (string)

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

Prefix -> (string)

The “YYYY/MM/DD/HH” time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects .

ErrorOutputPrefix -> (string)

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 .

BufferingHints -> (structure)

The buffering option. If no value is specified, BufferingHints object default values are used.

SizeInMBs -> (integer)

Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds , and vice versa.

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 MiB/sec, the value should be 10 MiB or higher.

IntervalInSeconds -> (integer)

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs , and vice versa.

CompressionFormat -> (string)

The compression format. If no value is specified, the default is UNCOMPRESSED .

EncryptionConfiguration -> (structure)

The encryption configuration. If no value is specified, the default is no encryption.

NoEncryptionConfig -> (string)

Specifically override existing encryption information to ensure that no encryption is used.

KMSEncryptionConfig -> (structure)

The encryption key.

AWSKMSKeyARN -> (string)

The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

CloudWatchLoggingOptions -> (structure)

The Amazon CloudWatch logging options for your delivery stream.

Enabled -> (boolean)

Enables or disables CloudWatch logging.

LogGroupName -> (string)

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

LogStreamName -> (string)

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

CloudWatchLoggingOptions -> (structure)

The Amazon CloudWatch logging options for your delivery stream.

Enabled -> (boolean)

Enables or disables CloudWatch logging.

LogGroupName -> (string)

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

LogStreamName -> (string)

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

ElasticsearchDestinationDescription -> (structure)

The destination in Amazon ES.

RoleARN -> (string)

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

DomainARN -> (string)

The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.

ClusterEndpoint -> (string)

The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.

IndexName -> (string)

The Elasticsearch index name.

TypeName -> (string)

The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x, there’s no value for TypeName .

IndexRotationPeriod -> (string)

The Elasticsearch index rotation period

BufferingHints -> (structure)

The buffering options.

IntervalInSeconds -> (integer)

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).

SizeInMBs -> (integer)

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.

RetryOptions -> (structure)

The Amazon ES retry options.

DurationInSeconds -> (integer)

After an initial failure to deliver to Amazon ES, 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.

S3BackupMode -> (string)

The Amazon S3 backup mode.

S3DestinationDescription -> (structure)

The Amazon S3 destination.

RoleARN -> (string)

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

BucketARN -> (string)

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

Prefix -> (string)

The “YYYY/MM/DD/HH” time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects .

ErrorOutputPrefix -> (string)

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 .

BufferingHints -> (structure)

The buffering option. If no value is specified, BufferingHints object default values are used.

SizeInMBs -> (integer)

Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds , and vice versa.

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 MiB/sec, the value should be 10 MiB or higher.

IntervalInSeconds -> (integer)

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs , and vice versa.

CompressionFormat -> (string)

The compression format. If no value is specified, the default is UNCOMPRESSED .

EncryptionConfiguration -> (structure)

The encryption configuration. If no value is specified, the default is no encryption.

NoEncryptionConfig -> (string)

Specifically override existing encryption information to ensure that no encryption is used.

KMSEncryptionConfig -> (structure)

The encryption key.

AWSKMSKeyARN -> (string)

The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

CloudWatchLoggingOptions -> (structure)

The Amazon CloudWatch logging options for your delivery stream.

Enabled -> (boolean)

Enables or disables CloudWatch logging.

LogGroupName -> (string)

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

LogStreamName -> (string)

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

ProcessingConfiguration -> (structure)

The data processing configuration.

Enabled -> (boolean)

Enables or disables data processing.

Processors -> (list)

The data processors.

(structure)

Describes a data processor.

Type -> (string)

The type of processor.

Parameters -> (list)

The processor parameters.

(structure)

Describes the processor parameter.

ParameterName -> (string)

The name of the parameter.

ParameterValue -> (string)

The parameter value.

CloudWatchLoggingOptions -> (structure)

The Amazon CloudWatch logging options.

Enabled -> (boolean)

Enables or disables CloudWatch logging.

LogGroupName -> (string)

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

LogStreamName -> (string)

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

VpcConfigurationDescription -> (structure)

The details of the VPC of the Amazon ES destination.

SubnetIds -> (list)

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. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

(string)

RoleARN -> (string)

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

SecurityGroupIds -> (list)

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

(string)

VpcId -> (string)

The ID of the Amazon ES destination’s VPC.

SplunkDestinationDescription -> (structure)

The destination in Splunk.

HECEndpoint -> (string)

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

HECEndpointType -> (string)

This type can be either “Raw” or “Event.”

HECToken -> (string)

A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.

HECAcknowledgmentTimeoutInSeconds -> (integer)

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.

RetryOptions -> (structure)

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.

DurationInSeconds -> (integer)

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.

S3BackupMode -> (string)

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly , Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments , Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly .

S3DestinationDescription -> (structure)

The Amazon S3 destination.>

RoleARN -> (string)

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

BucketARN -> (string)

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

Prefix -> (string)

The “YYYY/MM/DD/HH” time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects .

ErrorOutputPrefix -> (string)

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 .

BufferingHints -> (structure)

The buffering option. If no value is specified, BufferingHints object default values are used.

SizeInMBs -> (integer)

Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds , and vice versa.

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 MiB/sec, the value should be 10 MiB or higher.

IntervalInSeconds -> (integer)

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs , and vice versa.

CompressionFormat -> (string)

The compression format. If no value is specified, the default is UNCOMPRESSED .

EncryptionConfiguration -> (structure)

The encryption configuration. If no value is specified, the default is no encryption.

NoEncryptionConfig -> (string)

Specifically override existing encryption information to ensure that no encryption is used.

KMSEncryptionConfig -> (structure)

The encryption key.

AWSKMSKeyARN -> (string)

The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .

CloudWatchLoggingOptions -> (structure)

The Amazon CloudWatch logging options for your delivery stream.

Enabled -> (boolean)

Enables or disables CloudWatch logging.

LogGroupName -> (string)

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

LogStreamName -> (string)

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

ProcessingConfiguration -> (structure)

The data processing configuration.

Enabled -> (boolean)

Enables or disables data processing.

Processors -> (list)

The data processors.

(structure)

Describes a data processor.

Type -> (string)

The type of processor.

Parameters -> (list)

The processor parameters.

(structure)

Describes the processor parameter.

ParameterName -> (string)

The name of the parameter.

ParameterValue -> (string)

The parameter value.

CloudWatchLoggingOptions -> (structure)

The Amazon CloudWatch logging options for your delivery stream.

Enabled -> (boolean)

Enables or disables CloudWatch logging.

LogGroupName -> (string)

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

LogStreamName -> (string)

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

HasMoreDestinations -> (boolean)

Indicates whether there are more destinations available to list.