describe-delivery-stream
Description
Describes the specified Firehose stream and its status. For example, after your Firehose stream is created, call DescribeDeliveryStream to see whether the Firehose stream is ACTIVE and therefore ready for data to be sent to it.
If the status of a Firehose 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
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>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options
--delivery-stream-name (string)
--limit (integer)
--exclusive-start-destination-id (string)
--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output
DeliveryStreamDescription -> (structure)
Information about the Firehose stream.
DeliveryStreamName -> (string)
DeliveryStreamARN -> (string)
DeliveryStreamStatus -> (string)
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)
Details -> (string)
DeliveryStreamEncryptionConfiguration -> (structure)
Indicates the server-side encryption (SSE) status for the Firehose stream.
KeyARN -> (string)
KeyType is CUSTOMER_MANAGED_CMK , this field contains the ARN of the customer managed CMK. If KeyType is Amazon Web Services_OWNED_CMK , DeliveryStreamEncryptionConfiguration doesn’t contain a value for KeyARN .KeyType -> (string)
Amazon Web Services_OWNED_CMK . For more information about CMKs, see Customer Master Keys (CMKs) .Status -> (string)
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)
Details -> (string)
DeliveryStreamType -> (string)
The Firehose stream type. This can be one of the following values:
-
DirectPut: Provider applications access the Firehose stream directly. -
KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.
VersionId -> (string)
CreateTimestamp -> (timestamp)
LastUpdateTimestamp -> (timestamp)
Source -> (structure)
If the DeliveryStreamType parameter is KinesisStreamAsSource , a SourceDescription object describing the source Kinesis data stream.
DirectPutSourceDescription -> (structure)
Details about Direct PUT used as the source for a Firehose stream.
ThroughputHintInMBs -> (integer)
KinesisStreamSourceDescription -> (structure)
The KinesisStreamSourceDescription value for the source Kinesis data stream.
KinesisStreamARN -> (string)
RoleARN -> (string)
DeliveryStartTimestamp -> (timestamp)
MSKSourceDescription -> (structure)
The configuration description for the Amazon MSK cluster to be used as the source for a delivery stream.
MSKClusterARN -> (string)
TopicName -> (string)
AuthenticationConfiguration -> (structure)
The authentication configuration of the Amazon MSK cluster.
RoleARN -> (string)
Connectivity -> (string)
DeliveryStartTimestamp -> (timestamp)
ReadFromTimestamp -> (timestamp)
The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.
If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestampUTC parameter to Epoch (1970-01-01T00:00:00Z).
DatabaseSourceDescription -> (structure)
Details about a database used as the source for a Firehose stream.
Amazon Data Firehose is in preview release and is subject to change.
Type -> (string)
The type of database engine. This can be one of the following values.
- MySQL
- PostgreSQL
Amazon Data Firehose is in preview release and is subject to change.
Endpoint -> (string)
The endpoint of the database server.
Amazon Data Firehose is in preview release and is subject to change.
Port -> (integer)
The port of the database. This can be one of the following values.
- 3306 for MySQL database type
- 5432 for PostgreSQL database type
Amazon Data Firehose is in preview release and is subject to change.
SSLMode -> (string)
The mode to enable or disable SSL when Firehose connects to the database endpoint.
Amazon Data Firehose is in preview release and is subject to change.
Databases -> (structure)
The list of database patterns in source database endpoint for Firehose to read from.
Amazon Data Firehose is in preview release and is subject to change.
Include -> (list)
The list of database patterns in source database endpoint to be included for Firehose to read from.
Amazon Data Firehose is in preview release and is subject to change.
(string)
Exclude -> (list)
The list of database patterns in source database endpoint to be excluded for Firehose to read from.
Amazon Data Firehose is in preview release and is subject to change.
(string)
Tables -> (structure)
The list of table patterns in source database endpoint for Firehose to read from.
Amazon Data Firehose is in preview release and is subject to change.
Include -> (list)
The list of table patterns in source database endpoint to be included for Firehose to read from.
Amazon Data Firehose is in preview release and is subject to change.
(string)
Exclude -> (list)
The list of table patterns in source database endpoint to be excluded for Firehose to read from.
Amazon Data Firehose is in preview release and is subject to change.
(string)
Columns -> (structure)
The list of column patterns in source database endpoint for Firehose to read from.
Amazon Data Firehose is in preview release and is subject to change.
Include -> (list)
The list of column patterns in source database to be included for Firehose to read from.
Amazon Data Firehose is in preview release and is subject to change.
(string)
Exclude -> (list)
The list of column patterns in source database to be excluded for Firehose to read from.
Amazon Data Firehose is in preview release and is subject to change.
(string)
SurrogateKeys -> (list)
The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured.
Amazon Data Firehose is in preview release and is subject to change.
(string)
SnapshotWatermarkTable -> (string)
The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.
Amazon Data Firehose is in preview release and is subject to change.
SnapshotInfo -> (list)
The structure that describes the snapshot information of a table in source database endpoint that Firehose reads.
Amazon Data Firehose is in preview release and is subject to change.
(structure)
The structure that describes the snapshot information of a table in source database endpoint that Firehose reads.
Amazon Data Firehose is in preview release and is subject to change.
Id -> (string)
The identifier of the current snapshot of the table in source database endpoint.
Amazon Data Firehose is in preview release and is subject to change.
Table -> (string)
The fully qualified name of the table in source database endpoint that Firehose reads.
Amazon Data Firehose is in preview release and is subject to change.
RequestTimestamp -> (timestamp)
The timestamp when the current snapshot is taken on the table.
Amazon Data Firehose is in preview release and is subject to change.
RequestedBy -> (string)
The principal that sent the request to take the current snapshot on the table.
Amazon Data Firehose is in preview release and is subject to change.
Status -> (string)
The status of the current snapshot of the table.
Amazon Data Firehose is in preview release and is subject to change.
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)
Details -> (string)
DatabaseSourceAuthenticationConfiguration -> (structure)
The structure to configure the authentication methods for Firehose to connect to source database endpoint.
Amazon Data Firehose is in preview release and is subject to change.
SecretsManagerConfiguration -> (structure)
The structure that defines how Firehose accesses the secret.
SecretARN -> (string)
True .RoleARN -> (string)
Enabled -> (boolean)
True the secrets manager configuration overwrites the existing secrets in the destination configuration. When it’s set to False Firehose falls back to the credentials in the destination configuration.DatabaseSourceVPCConfiguration -> (structure)
The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.
Amazon Data Firehose is in preview release and is subject to change.
VpcEndpointServiceName -> (string)
The VPC endpoint service name which Firehose uses to create a PrivateLink to the database. The endpoint service must have the Firehose service principle firehose.amazonaws.com as an allowed principal on the VPC endpoint service. The VPC endpoint service name is a string that looks like com.amazonaws.vpce.<region>.<vpc-endpoint-service-id> .
Amazon Data Firehose is in preview release and is subject to change.
Destinations -> (list)
The destinations.
(structure)
Describes the destination for a Firehose stream.
DestinationId -> (string)
S3DestinationDescription -> (structure)
[Deprecated] The destination in Amazon S3.
RoleARN -> (string)
BucketARN -> (string)
Prefix -> (string)
ErrorOutputPrefix -> (string)
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 Firehose 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)
SizeInMBs , and vice versa.CompressionFormat -> (string)
UNCOMPRESSED .EncryptionConfiguration -> (structure)
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig -> (string)
KMSEncryptionConfig -> (structure)
The encryption key.
AWSKMSKeyARN -> (string)
CloudWatchLoggingOptions -> (structure)
The Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
ExtendedS3DestinationDescription -> (structure)
The destination in Amazon S3.
RoleARN -> (string)
BucketARN -> (string)
Prefix -> (string)
ErrorOutputPrefix -> (string)
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 Firehose 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)
SizeInMBs , and vice versa.CompressionFormat -> (string)
UNCOMPRESSED .EncryptionConfiguration -> (structure)
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig -> (string)
KMSEncryptionConfig -> (structure)
The encryption key.
AWSKMSKeyARN -> (string)
CloudWatchLoggingOptions -> (structure)
The Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
ProcessingConfiguration -> (structure)
The data processing configuration.
Enabled -> (boolean)
Processors -> (list)
The data processors.
(structure)
Describes a data processor.
Note
If you want to add a new line delimiter between records in objects that are delivered to Amazon S3, chooseAppendDelimiterToRecord as a processor type. You don’t have to put a processor parameter when you select AppendDelimiterToRecord .Type -> (string)
Parameters -> (list)
The processor parameters.
(structure)
Describes the processor parameter.
ParameterName -> (string)
NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB.ParameterValue -> (string)
S3BackupMode -> (string)
S3BackupDescription -> (structure)
The configuration for backup in Amazon S3.
RoleARN -> (string)
BucketARN -> (string)
Prefix -> (string)
ErrorOutputPrefix -> (string)
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 Firehose 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)
SizeInMBs , and vice versa.CompressionFormat -> (string)
UNCOMPRESSED .EncryptionConfiguration -> (structure)
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig -> (string)
KMSEncryptionConfig -> (structure)
The encryption key.
AWSKMSKeyARN -> (string)
CloudWatchLoggingOptions -> (structure)
The Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
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 Amazon Web Services Glue Data Catalog table that contains the column information. This parameter is required if Enabled is set to true.
RoleARN -> (string)
The role that Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Firehose. Cross-account roles aren’t allowed.
Warning
If theSchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.CatalogId -> (string)
DatabaseName -> (string)
Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.
Warning
If theSchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.TableName -> (string)
Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.
Warning
If theSchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.Region -> (string)
VersionId -> (string)
LATEST , 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 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 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 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)
true , which is the default, 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 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 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, Firehose uses java.sql.Timestamp::valueOf by default.
(string)
OutputFormatConfiguration -> (structure)
Specifies the serializer that you want 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)
PageSizeBytes -> (integer)
Compression -> (string)
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)
MaxPaddingBytes -> (integer)
WriterVersion -> (string)
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)
BlockSizeBytes -> (integer)
RowIndexStride -> (integer)
EnablePadding -> (boolean)
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.
Firehose ignores this parameter when OrcSerDe$EnablePadding is false .
Compression -> (string)
SNAPPY .BloomFilterColumns -> (list)
The column names for which you want Firehose to create bloom filters. The default is null .
(string)
BloomFilterFalsePositiveProbability -> (double)
DictionaryKeyThreshold -> (double)
FormatVersion -> (string)
V0_11 and V0_12 . The default is V0_12 .Enabled -> (boolean)
true . Set it to false if you want to disable format conversion while preserving the configuration details.DynamicPartitioningConfiguration -> (structure)
The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
RetryOptions -> (structure)
The retry behavior in case Firehose is unable to deliver data to an Amazon S3 prefix.
DurationInSeconds -> (integer)
Enabled -> (boolean)
FileExtension -> (string)
CustomTimeZone -> (string)
RedshiftDestinationDescription -> (structure)
The destination in Amazon Redshift.
RoleARN -> (string)
ClusterJDBCURL -> (string)
CopyCommand -> (structure)
The COPY command.
DataTableName -> (string)
DataTableColumns -> (string)
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 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)
RetryOptions -> (structure)
The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
DurationInSeconds -> (integer)
DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.S3DestinationDescription -> (structure)
The Amazon S3 destination.
RoleARN -> (string)
BucketARN -> (string)
Prefix -> (string)
ErrorOutputPrefix -> (string)
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 Firehose 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)
SizeInMBs , and vice versa.CompressionFormat -> (string)
UNCOMPRESSED .EncryptionConfiguration -> (structure)
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig -> (string)
KMSEncryptionConfig -> (structure)
The encryption key.
AWSKMSKeyARN -> (string)
CloudWatchLoggingOptions -> (structure)
The Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
ProcessingConfiguration -> (structure)
The data processing configuration.
Enabled -> (boolean)
Processors -> (list)
The data processors.
(structure)
Describes a data processor.
Note
If you want to add a new line delimiter between records in objects that are delivered to Amazon S3, chooseAppendDelimiterToRecord as a processor type. You don’t have to put a processor parameter when you select AppendDelimiterToRecord .Type -> (string)
Parameters -> (list)
The processor parameters.
(structure)
Describes the processor parameter.
ParameterName -> (string)
NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB.ParameterValue -> (string)
S3BackupMode -> (string)
S3BackupDescription -> (structure)
The configuration for backup in Amazon S3.
RoleARN -> (string)
BucketARN -> (string)
Prefix -> (string)
ErrorOutputPrefix -> (string)
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 Firehose 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)
SizeInMBs , and vice versa.CompressionFormat -> (string)
UNCOMPRESSED .EncryptionConfiguration -> (structure)
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig -> (string)
KMSEncryptionConfig -> (structure)
The encryption key.
AWSKMSKeyARN -> (string)
CloudWatchLoggingOptions -> (structure)
The Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
CloudWatchLoggingOptions -> (structure)
The Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
SecretsManagerConfiguration -> (structure)
The configuration that defines how you access secrets for Amazon Redshift.
SecretARN -> (string)
True .RoleARN -> (string)
Enabled -> (boolean)
True the secrets manager configuration overwrites the existing secrets in the destination configuration. When it’s set to False Firehose falls back to the credentials in the destination configuration.ElasticsearchDestinationDescription -> (structure)
The destination in Amazon OpenSearch Service.
RoleARN -> (string)
DomainARN -> (string)
The ARN of the Amazon OpenSearch Service domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon OpenSearch Service.
ClusterEndpoint -> (string)
ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.IndexName -> (string)
TypeName -> (string)
TypeName .IndexRotationPeriod -> (string)
BufferingHints -> (structure)
The buffering options.
IntervalInSeconds -> (integer)
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 Firehose 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 OpenSearch Service retry options.
DurationInSeconds -> (integer)
S3BackupMode -> (string)
S3DestinationDescription -> (structure)
The Amazon S3 destination.
RoleARN -> (string)
BucketARN -> (string)
Prefix -> (string)
ErrorOutputPrefix -> (string)
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 Firehose 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)
SizeInMBs , and vice versa.CompressionFormat -> (string)
UNCOMPRESSED .EncryptionConfiguration -> (structure)
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig -> (string)
KMSEncryptionConfig -> (structure)
The encryption key.
AWSKMSKeyARN -> (string)
CloudWatchLoggingOptions -> (structure)
The Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
ProcessingConfiguration -> (structure)
The data processing configuration.
Enabled -> (boolean)
Processors -> (list)
The data processors.
(structure)
Describes a data processor.
Note
If you want to add a new line delimiter between records in objects that are delivered to Amazon S3, chooseAppendDelimiterToRecord as a processor type. You don’t have to put a processor parameter when you select AppendDelimiterToRecord .Type -> (string)
Parameters -> (list)
The processor parameters.
(structure)
Describes the processor parameter.
ParameterName -> (string)
NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB.ParameterValue -> (string)
CloudWatchLoggingOptions -> (structure)
The Amazon CloudWatch logging options.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
VpcConfigurationDescription -> (structure)
The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.
SubnetIds -> (list)
The IDs of the subnets that Firehose uses to create ENIs in the VPC of the Amazon OpenSearch Service 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 OpenSearch Service endpoints. 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 Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable 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 Firehose can create up to three ENIs for this Firehose 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 the Firehose stream uses to create endpoints in the destination VPC. You can use your existing Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions:
ec2:DescribeVpcsec2:DescribeVpcAttributeec2:DescribeSubnetsec2:DescribeSecurityGroupsec2:DescribeNetworkInterfacesec2:CreateNetworkInterfaceec2:CreateNetworkInterfacePermissionec2:DeleteNetworkInterface
If you revoke these permissions after you create the Firehose stream, Firehose can’t scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.
SecurityGroupIds -> (list)
The IDs of the security groups that Firehose uses when it creates ENIs in the VPC of the Amazon OpenSearch Service destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups, ensure that they allow outbound HTTPS traffic to the Amazon OpenSearch Service domain’s security group. Also ensure that the Amazon OpenSearch Service domain’s security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your Firehose stream and the Amazon OpenSearch Service domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.
(string)
VpcId -> (string)
DocumentIdOptions -> (structure)
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
DefaultDocumentIdFormat -> (string)
When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.
When the NO_DOCUMENT_ID option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.
AmazonopensearchserviceDestinationDescription -> (structure)
The destination in Amazon OpenSearch Service.
RoleARN -> (string)
DomainARN -> (string)
ClusterEndpoint -> (string)
IndexName -> (string)
TypeName -> (string)
IndexRotationPeriod -> (string)
BufferingHints -> (structure)
The buffering options.
IntervalInSeconds -> (integer)
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 Firehose 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 OpenSearch Service retry options.
DurationInSeconds -> (integer)
S3BackupMode -> (string)
S3DestinationDescription -> (structure)
Describes a destination in Amazon S3.
RoleARN -> (string)
BucketARN -> (string)
Prefix -> (string)
ErrorOutputPrefix -> (string)
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 Firehose 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)
SizeInMBs , and vice versa.CompressionFormat -> (string)
UNCOMPRESSED .EncryptionConfiguration -> (structure)
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig -> (string)
KMSEncryptionConfig -> (structure)
The encryption key.
AWSKMSKeyARN -> (string)
CloudWatchLoggingOptions -> (structure)
The Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
ProcessingConfiguration -> (structure)
Describes a data processing configuration.
Enabled -> (boolean)
Processors -> (list)
The data processors.
(structure)
Describes a data processor.
Note
If you want to add a new line delimiter between records in objects that are delivered to Amazon S3, chooseAppendDelimiterToRecord as a processor type. You don’t have to put a processor parameter when you select AppendDelimiterToRecord .Type -> (string)
Parameters -> (list)
The processor parameters.
(structure)
Describes the processor parameter.
ParameterName -> (string)
NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB.ParameterValue -> (string)
CloudWatchLoggingOptions -> (structure)
Describes the Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
VpcConfigurationDescription -> (structure)
The details of the VPC of the Amazon OpenSearch Service destination.
SubnetIds -> (list)
The IDs of the subnets that Firehose uses to create ENIs in the VPC of the Amazon OpenSearch Service 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 OpenSearch Service endpoints. 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 Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable 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 Firehose can create up to three ENIs for this Firehose 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 the Firehose stream uses to create endpoints in the destination VPC. You can use your existing Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions:
ec2:DescribeVpcsec2:DescribeVpcAttributeec2:DescribeSubnetsec2:DescribeSecurityGroupsec2:DescribeNetworkInterfacesec2:CreateNetworkInterfaceec2:CreateNetworkInterfacePermissionec2:DeleteNetworkInterface
If you revoke these permissions after you create the Firehose stream, Firehose can’t scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.
SecurityGroupIds -> (list)
The IDs of the security groups that Firehose uses when it creates ENIs in the VPC of the Amazon OpenSearch Service destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups, ensure that they allow outbound HTTPS traffic to the Amazon OpenSearch Service domain’s security group. Also ensure that the Amazon OpenSearch Service domain’s security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your Firehose stream and the Amazon OpenSearch Service domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.
(string)
VpcId -> (string)
DocumentIdOptions -> (structure)
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
DefaultDocumentIdFormat -> (string)
When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.
When the NO_DOCUMENT_ID option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.
SplunkDestinationDescription -> (structure)
The destination in Splunk.
HECEndpoint -> (string)
HECEndpointType -> (string)
HECToken -> (string)
HECAcknowledgmentTimeoutInSeconds -> (integer)
RetryOptions -> (structure)
The retry behavior in case Firehose is unable to deliver data to Splunk or if it doesn’t receive an acknowledgment of receipt from Splunk.
DurationInSeconds -> (integer)
S3BackupMode -> (string)
FailedDocumentsOnly , Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments , 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)
BucketARN -> (string)
Prefix -> (string)
ErrorOutputPrefix -> (string)
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 Firehose 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)
SizeInMBs , and vice versa.CompressionFormat -> (string)
UNCOMPRESSED .EncryptionConfiguration -> (structure)
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig -> (string)
KMSEncryptionConfig -> (structure)
The encryption key.
AWSKMSKeyARN -> (string)
CloudWatchLoggingOptions -> (structure)
The Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
ProcessingConfiguration -> (structure)
The data processing configuration.
Enabled -> (boolean)
Processors -> (list)
The data processors.
(structure)
Describes a data processor.
Note
If you want to add a new line delimiter between records in objects that are delivered to Amazon S3, chooseAppendDelimiterToRecord as a processor type. You don’t have to put a processor parameter when you select AppendDelimiterToRecord .Type -> (string)
Parameters -> (list)
The processor parameters.
(structure)
Describes the processor parameter.
ParameterName -> (string)
NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB.ParameterValue -> (string)
CloudWatchLoggingOptions -> (structure)
The Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
BufferingHints -> (structure)
The buffering options. If no value is specified, the default values for Splunk are used.
IntervalInSeconds -> (integer)
SizeInMBs -> (integer)
SecretsManagerConfiguration -> (structure)
The configuration that defines how you access secrets for Splunk.
SecretARN -> (string)
True .RoleARN -> (string)
Enabled -> (boolean)
True the secrets manager configuration overwrites the existing secrets in the destination configuration. When it’s set to False Firehose falls back to the credentials in the destination configuration.HttpEndpointDestinationDescription -> (structure)
Describes the specified HTTP endpoint destination.
EndpointConfiguration -> (structure)
The configuration of the specified HTTP endpoint destination.
Url -> (string)
Name -> (string)
BufferingHints -> (structure)
Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Firehose teats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.
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 Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
IntervalInSeconds -> (integer)
CloudWatchLoggingOptions -> (structure)
Describes the Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
RequestConfiguration -> (structure)
The configuration of request sent to the HTTP endpoint specified as the destination.
ContentEncoding -> (string)
CommonAttributes -> (list)
Describes the metadata sent to the HTTP endpoint destination.
(structure)
Describes the metadata that’s delivered to the specified HTTP endpoint destination.
AttributeName -> (string)
AttributeValue -> (string)
ProcessingConfiguration -> (structure)
Describes a data processing configuration.
Enabled -> (boolean)
Processors -> (list)
The data processors.
(structure)
Describes a data processor.
Note
If you want to add a new line delimiter between records in objects that are delivered to Amazon S3, chooseAppendDelimiterToRecord as a processor type. You don’t have to put a processor parameter when you select AppendDelimiterToRecord .Type -> (string)
Parameters -> (list)
The processor parameters.
(structure)
Describes the processor parameter.
ParameterName -> (string)
NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB.ParameterValue -> (string)
RoleARN -> (string)
RetryOptions -> (structure)
Describes the retry behavior in case 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.
DurationInSeconds -> (integer)
S3BackupMode -> (string)
AllData ) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly ).S3DestinationDescription -> (structure)
Describes a destination in Amazon S3.
RoleARN -> (string)
BucketARN -> (string)
Prefix -> (string)
ErrorOutputPrefix -> (string)
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 Firehose 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)
SizeInMBs , and vice versa.CompressionFormat -> (string)
UNCOMPRESSED .EncryptionConfiguration -> (structure)
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig -> (string)
KMSEncryptionConfig -> (structure)
The encryption key.
AWSKMSKeyARN -> (string)
CloudWatchLoggingOptions -> (structure)
The Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
SecretsManagerConfiguration -> (structure)
The configuration that defines how you access secrets for HTTP Endpoint destination.
SecretARN -> (string)
True .RoleARN -> (string)
Enabled -> (boolean)
True the secrets manager configuration overwrites the existing secrets in the destination configuration. When it’s set to False Firehose falls back to the credentials in the destination configuration.SnowflakeDestinationDescription -> (structure)
Optional description for the destination
AccountUrl -> (string)
User -> (string)
Database -> (string)
Schema -> (string)
Table -> (string)
SnowflakeRoleConfiguration -> (structure)
Optionally configure a Snowflake role. Otherwise the default user role will be used.
Enabled -> (boolean)
SnowflakeRole -> (string)
DataLoadingOption -> (string)
MetaDataColumnName -> (string)
ContentColumnName -> (string)
SnowflakeVpcConfiguration -> (structure)
The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see Amazon PrivateLink & Snowflake
PrivateLinkVpceId -> (string)
CloudWatchLoggingOptions -> (structure)
Describes the Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
ProcessingConfiguration -> (structure)
Describes a data processing configuration.
Enabled -> (boolean)
Processors -> (list)
The data processors.
(structure)
Describes a data processor.
Note
If you want to add a new line delimiter between records in objects that are delivered to Amazon S3, chooseAppendDelimiterToRecord as a processor type. You don’t have to put a processor parameter when you select AppendDelimiterToRecord .Type -> (string)
Parameters -> (list)
The processor parameters.
(structure)
Describes the processor parameter.
ParameterName -> (string)
NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB.ParameterValue -> (string)
RoleARN -> (string)
RetryOptions -> (structure)
The time period where Firehose will retry sending data to the chosen HTTP endpoint.
DurationInSeconds -> (integer)
S3BackupMode -> (string)
S3DestinationDescription -> (structure)
Describes a destination in Amazon S3.
RoleARN -> (string)
BucketARN -> (string)
Prefix -> (string)
ErrorOutputPrefix -> (string)
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 Firehose 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)
SizeInMBs , and vice versa.CompressionFormat -> (string)
UNCOMPRESSED .EncryptionConfiguration -> (structure)
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig -> (string)
KMSEncryptionConfig -> (structure)
The encryption key.
AWSKMSKeyARN -> (string)
CloudWatchLoggingOptions -> (structure)
The Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
SecretsManagerConfiguration -> (structure)
The configuration that defines how you access secrets for Snowflake.
SecretARN -> (string)
True .RoleARN -> (string)
Enabled -> (boolean)
True the secrets manager configuration overwrites the existing secrets in the destination configuration. When it’s set to False Firehose falls back to the credentials in the destination configuration.BufferingHints -> (structure)
Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.
SizeInMBs -> (integer)
IntervalInSeconds -> (integer)
AmazonOpenSearchServerlessDestinationDescription -> (structure)
The destination in the Serverless offering for Amazon OpenSearch Service.
RoleARN -> (string)
CollectionEndpoint -> (string)
IndexName -> (string)
BufferingHints -> (structure)
The buffering options.
IntervalInSeconds -> (integer)
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 Firehose 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 Serverless offering for Amazon OpenSearch Service retry options.
DurationInSeconds -> (integer)
S3BackupMode -> (string)
S3DestinationDescription -> (structure)
Describes a destination in Amazon S3.
RoleARN -> (string)
BucketARN -> (string)
Prefix -> (string)
ErrorOutputPrefix -> (string)
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 Firehose 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)
SizeInMBs , and vice versa.CompressionFormat -> (string)
UNCOMPRESSED .EncryptionConfiguration -> (structure)
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig -> (string)
KMSEncryptionConfig -> (structure)
The encryption key.
AWSKMSKeyARN -> (string)
CloudWatchLoggingOptions -> (structure)
The Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
ProcessingConfiguration -> (structure)
Describes a data processing configuration.
Enabled -> (boolean)
Processors -> (list)
The data processors.
(structure)
Describes a data processor.
Note
If you want to add a new line delimiter between records in objects that are delivered to Amazon S3, chooseAppendDelimiterToRecord as a processor type. You don’t have to put a processor parameter when you select AppendDelimiterToRecord .Type -> (string)
Parameters -> (list)
The processor parameters.
(structure)
Describes the processor parameter.
ParameterName -> (string)
NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB.ParameterValue -> (string)
CloudWatchLoggingOptions -> (structure)
Describes the Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
VpcConfigurationDescription -> (structure)
The details of the VPC of the Amazon OpenSearch Service destination.
SubnetIds -> (list)
The IDs of the subnets that Firehose uses to create ENIs in the VPC of the Amazon OpenSearch Service 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 OpenSearch Service endpoints. 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 Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable 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 Firehose can create up to three ENIs for this Firehose 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 the Firehose stream uses to create endpoints in the destination VPC. You can use your existing Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions:
ec2:DescribeVpcsec2:DescribeVpcAttributeec2:DescribeSubnetsec2:DescribeSecurityGroupsec2:DescribeNetworkInterfacesec2:CreateNetworkInterfaceec2:CreateNetworkInterfacePermissionec2:DeleteNetworkInterface
If you revoke these permissions after you create the Firehose stream, Firehose can’t scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.
SecurityGroupIds -> (list)
The IDs of the security groups that Firehose uses when it creates ENIs in the VPC of the Amazon OpenSearch Service destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups, ensure that they allow outbound HTTPS traffic to the Amazon OpenSearch Service domain’s security group. Also ensure that the Amazon OpenSearch Service domain’s security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your Firehose stream and the Amazon OpenSearch Service domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.
(string)
VpcId -> (string)
IcebergDestinationDescription -> (structure)
Describes a destination in Apache Iceberg Tables.
DestinationTableConfigurationList -> (list)
Provides a list of DestinationTableConfigurations which Firehose uses to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here.
(structure)
Describes the configuration of a destination in Apache Iceberg Tables.
DestinationTableName -> (string)
DestinationDatabaseName -> (string)
UniqueKeys -> (list)
A list of unique keys for a given Apache Iceberg table. Firehose will use these for running Create, Update, or Delete operations on the given Iceberg table.
(string)
PartitionSpec -> (structure)
The partition spec configuration for a table that is used by automatic table creation.
Amazon Data Firehose is in preview release and is subject to change.
Identity -> (list)
List of identity transforms that performs an identity transformation. The transform takes the source value, and does not modify it. Result type is the source type.
Amazon Data Firehose is in preview release and is subject to change.
(structure)
Represents a single field in a PartitionSpec .
Amazon Data Firehose is in preview release and is subject to change.
SourceName -> (string)
The column name to be configured in partition spec.
Amazon Data Firehose is in preview release and is subject to change.
S3ErrorOutputPrefix -> (string)
SchemaEvolutionConfiguration -> (structure)
The description of automatic schema evolution configuration.
Amazon Data Firehose is in preview release and is subject to change.
Enabled -> (boolean)
Specify whether you want to enable schema evolution.
Amazon Data Firehose is in preview release and is subject to change.
TableCreationConfiguration -> (structure)
The description of table creation configuration.
Amazon Data Firehose is in preview release and is subject to change.
Enabled -> (boolean)
Specify whether you want to enable automatic table creation.
Amazon Data Firehose is in preview release and is subject to change.
BufferingHints -> (structure)
Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Firehose might choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.
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 Firehose 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)
SizeInMBs , and vice versa.CloudWatchLoggingOptions -> (structure)
Describes the Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
ProcessingConfiguration -> (structure)
Describes a data processing configuration.
Enabled -> (boolean)
Processors -> (list)
The data processors.
(structure)
Describes a data processor.
Note
If you want to add a new line delimiter between records in objects that are delivered to Amazon S3, chooseAppendDelimiterToRecord as a processor type. You don’t have to put a processor parameter when you select AppendDelimiterToRecord .Type -> (string)
Parameters -> (list)
The processor parameters.
(structure)
Describes the processor parameter.
ParameterName -> (string)
NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB.ParameterValue -> (string)
S3BackupMode -> (string)
FailedDataOnly .RetryOptions -> (structure)
The retry behavior in case Firehose is unable to deliver data to a destination.
DurationInSeconds -> (integer)
RoleARN -> (string)
AppendOnly -> (boolean)
Describes whether all incoming data for this delivery stream will be append only (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only applicable for Apache Iceberg Tables.
The default value is false. If you set this value to true, Firehose automatically increases the throughput limit of a stream based on the throttling levels of the stream. If you set this parameter to true for a stream with updates and deletes, you will see out of order delivery.
CatalogConfiguration -> (structure)
Configuration describing where the destination Iceberg tables are persisted.
CatalogARN -> (string)
arn:aws:glue:region:account-id:catalog .WarehouseLocation -> (string)
The warehouse location for Apache Iceberg tables. You must configure this when schema evolution and table creation is enabled.
Amazon Data Firehose is in preview release and is subject to change.
S3DestinationDescription -> (structure)
Describes a destination in Amazon S3.
RoleARN -> (string)
BucketARN -> (string)
Prefix -> (string)
ErrorOutputPrefix -> (string)
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 Firehose 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)
SizeInMBs , and vice versa.CompressionFormat -> (string)
UNCOMPRESSED .EncryptionConfiguration -> (structure)
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig -> (string)
KMSEncryptionConfig -> (structure)
The encryption key.
AWSKMSKeyARN -> (string)
CloudWatchLoggingOptions -> (structure)
The Amazon CloudWatch logging options for your Firehose stream.
Enabled -> (boolean)
LogGroupName -> (string)
LogStreamName -> (string)
HasMoreDestinations -> (boolean)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
