update-destination¶
Description¶
Updates the specified destination of the specified delivery stream.
Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.
Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.
If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination.
If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified.
Kinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream . Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.
See also: AWS API Documentation
Synopsis¶
update-destination
--delivery-stream-name <value>
--current-delivery-stream-version-id <value>
--destination-id <value>
[--s3-destination-update <value>]
[--extended-s3-destination-update <value>]
[--redshift-destination-update <value>]
[--elasticsearch-destination-update <value>]
[--amazonopensearchservice-destination-update <value>]
[--splunk-destination-update <value>]
[--http-endpoint-destination-update <value>]
[--amazon-open-search-serverless-destination-update <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)
The name of the delivery stream.
--current-delivery-stream-version-id (string)
Obtain this value from the
VersionIdresult of DeliveryStreamDescription . This value is required, and helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, theVersionIdvalue is updated. The service then performs a merge of the old configuration with the new configuration.
--destination-id (string)
The ID of the destination.
--s3-destination-update (structure)
[Deprecated] Describes an update for a destination in Amazon S3.
RoleARN -> (string)
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
BucketARN -> (string)
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services 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,
BufferingHintsobject 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.The compression formats
SNAPPYorZIPcannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPYoperation that reads from the S3 bucket.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 Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
CloudWatchLoggingOptions -> (structure)
The 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.
Shorthand Syntax:
RoleARN=string,BucketARN=string,Prefix=string,ErrorOutputPrefix=string,BufferingHints={SizeInMBs=integer,IntervalInSeconds=integer},CompressionFormat=string,EncryptionConfiguration={NoEncryptionConfig=string,KMSEncryptionConfig={AWSKMSKeyARN=string}},CloudWatchLoggingOptions={Enabled=boolean,LogGroupName=string,LogStreamName=string}
JSON Syntax:
{
"RoleARN": "string",
"BucketARN": "string",
"Prefix": "string",
"ErrorOutputPrefix": "string",
"BufferingHints": {
"SizeInMBs": integer,
"IntervalInSeconds": integer
},
"CompressionFormat": "UNCOMPRESSED"|"GZIP"|"ZIP"|"Snappy"|"HADOOP_SNAPPY",
"EncryptionConfiguration": {
"NoEncryptionConfig": "NoEncryption",
"KMSEncryptionConfig": {
"AWSKMSKeyARN": "string"
}
},
"CloudWatchLoggingOptions": {
"Enabled": true|false,
"LogGroupName": "string",
"LogStreamName": "string"
}
}
--extended-s3-destination-update (structure)
Describes an update for a destination in Amazon S3.
RoleARN -> (string)
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
BucketARN -> (string)
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services 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 Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services 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. Currently the following default values are supported: 3 for
NumberOfRetriesand 60 for theBufferIntervalInSeconds. TheBufferSizeInMBsranges 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)
The parameter value.
S3BackupMode -> (string)
You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can’t update the delivery stream to disable it.
S3BackupUpdate -> (structure)
The Amazon S3 destination for backup.
RoleARN -> (string)
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
BucketARN -> (string)
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services 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,
BufferingHintsobject 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.The compression formats
SNAPPYorZIPcannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPYoperation that reads from the S3 bucket.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 Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
CloudWatchLoggingOptions -> (structure)
The 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 Amazon Web Services Glue Data Catalog table that contains the column information. This parameter is required if
Enabledis set to true.RoleARN -> (string)
The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren’t allowed.
Warning
If the
SchemaConfigurationrequest parameter is used as part of invoking theCreateDeliveryStreamAPI, then theRoleARNproperty is required and its value must be specified.CatalogId -> (string)
The ID of the Amazon Web Services Glue Data Catalog. If you don’t supply this, the Amazon Web Services account ID is used by default.
DatabaseName -> (string)
Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.
Warning
If the
SchemaConfigurationrequest parameter is used as part of invoking theCreateDeliveryStreamAPI, then theDatabaseNameproperty 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 the
SchemaConfigurationrequest parameter is used as part of invoking theCreateDeliveryStreamAPI, then theTableNameproperty is required and its value must be specified.Region -> (string)
If you don’t specify an Amazon Web Services 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
Enabledis 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,
timestampis a Hive keyword. If you have a JSON key namedtimestamp, set this parameter to{"ts": "timestamp"}to map this key to a column namedts.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
millisto parse timestamps in epoch milliseconds. If you don’t specify a format, Kinesis Data Firehose usesjava.sql.Timestamp::valueOfby 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
Enabledis 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, andGZIP, with the default beingSNAPPY. UseSNAPPYfor higher decompression speed. UseGZIPif 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
V1andV2. The default isV1.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
trueto 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 isfalse.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_11andV0_12. The default isV0_12.Enabled -> (boolean)
Defaults to
true. Set it tofalseif 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 Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.
DurationInSeconds -> (integer)
The period of time during which Kinesis Data Firehose retries to deliver data to the specified Amazon S3 prefix.
Enabled -> (boolean)
Specifies that the dynamic partitioning is enabled for this Kinesis Data Firehose delivery stream.
JSON Syntax:
{ "RoleARN": "string", "BucketARN": "string", "Prefix": "string", "ErrorOutputPrefix": "string", "BufferingHints": { "SizeInMBs": integer, "IntervalInSeconds": integer }, "CompressionFormat": "UNCOMPRESSED"|"GZIP"|"ZIP"|"Snappy"|"HADOOP_SNAPPY", "EncryptionConfiguration": { "NoEncryptionConfig": "NoEncryption", "KMSEncryptionConfig": { "AWSKMSKeyARN": "string" } }, "CloudWatchLoggingOptions": { "Enabled": true|false, "LogGroupName": "string", "LogStreamName": "string" }, "ProcessingConfiguration": { "Enabled": true|false, "Processors": [ { "Type": "RecordDeAggregation"|"Lambda"|"MetadataExtraction"|"AppendDelimiterToRecord", "Parameters": [ { "ParameterName": "LambdaArn"|"NumberOfRetries"|"MetadataExtractionQuery"|"JsonParsingEngine"|"RoleArn"|"BufferSizeInMBs"|"BufferIntervalInSeconds"|"SubRecordType"|"Delimiter", "ParameterValue": "string" } ... ] } ... ] }, "S3BackupMode": "Disabled"|"Enabled", "S3BackupUpdate": { "RoleARN": "string", "BucketARN": "string", "Prefix": "string", "ErrorOutputPrefix": "string", "BufferingHints": { "SizeInMBs": integer, "IntervalInSeconds": integer }, "CompressionFormat": "UNCOMPRESSED"|"GZIP"|"ZIP"|"Snappy"|"HADOOP_SNAPPY", "EncryptionConfiguration": { "NoEncryptionConfig": "NoEncryption", "KMSEncryptionConfig": { "AWSKMSKeyARN": "string" } }, "CloudWatchLoggingOptions": { "Enabled": true|false, "LogGroupName": "string", "LogStreamName": "string" } }, "DataFormatConversionConfiguration": { "SchemaConfiguration": { "RoleARN": "string", "CatalogId": "string", "DatabaseName": "string", "TableName": "string", "Region": "string", "VersionId": "string" }, "InputFormatConfiguration": { "Deserializer": { "OpenXJsonSerDe": { "ConvertDotsInJsonKeysToUnderscores": true|false, "CaseInsensitive": true|false, "ColumnToJsonKeyMappings": {"string": "string" ...} }, "HiveJsonSerDe": { "TimestampFormats": ["string", ...] } } }, "OutputFormatConfiguration": { "Serializer": { "ParquetSerDe": { "BlockSizeBytes": integer, "PageSizeBytes": integer, "Compression": "UNCOMPRESSED"|"GZIP"|"SNAPPY", "EnableDictionaryCompression": true|false, "MaxPaddingBytes": integer, "WriterVersion": "V1"|"V2" }, "OrcSerDe": { "StripeSizeBytes": integer, "BlockSizeBytes": integer, "RowIndexStride": integer, "EnablePadding": true|false, "PaddingTolerance": double, "Compression": "NONE"|"ZLIB"|"SNAPPY", "BloomFilterColumns": ["string", ...], "BloomFilterFalsePositiveProbability": double, "DictionaryKeyThreshold": double, "FormatVersion": "V0_11"|"V0_12" } } }, "Enabled": true|false }, "DynamicPartitioningConfiguration": { "RetryOptions": { "DurationInSeconds": integer }, "Enabled": true|false } }
--redshift-destination-update(structure)Describes an update for a destination in Amazon Redshift.
RoleARN -> (string)
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
ClusterJDBCURL -> (string)
The database connection string.
CopyCommand -> (structure)
The
COPYcommand.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
COPYcommand. 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.
Password -> (string)
The user password.
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
DurationInSecondsis 0 (zero) or if the first delivery attempt takes longer than the current value.S3Update -> (structure)
The Amazon S3 destination.
The compression formats
SNAPPYorZIPcannot be specified inRedshiftDestinationUpdate.S3Updatebecause the Amazon RedshiftCOPYoperation that reads from the S3 bucket doesn’t support these compression formats.RoleARN -> (string)
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
BucketARN -> (string)
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services 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,
BufferingHintsobject 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.The compression formats
SNAPPYorZIPcannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPYoperation that reads from the S3 bucket.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 Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
CloudWatchLoggingOptions -> (structure)
The 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. Currently the following default values are supported: 3 for
NumberOfRetriesand 60 for theBufferIntervalInSeconds. TheBufferSizeInMBsranges 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)
The parameter value.
S3BackupMode -> (string)
You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can’t update the delivery stream to disable it.
S3BackupUpdate -> (structure)
The Amazon S3 destination for backup.
RoleARN -> (string)
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
BucketARN -> (string)
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services 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,
BufferingHintsobject 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.The compression formats
SNAPPYorZIPcannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPYoperation that reads from the S3 bucket.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 Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
CloudWatchLoggingOptions -> (structure)
The 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.
JSON Syntax:
{ "RoleARN": "string", "ClusterJDBCURL": "string", "CopyCommand": { "DataTableName": "string", "DataTableColumns": "string", "CopyOptions": "string" }, "Username": "string", "Password": "string", "RetryOptions": { "DurationInSeconds": integer }, "S3Update": { "RoleARN": "string", "BucketARN": "string", "Prefix": "string", "ErrorOutputPrefix": "string", "BufferingHints": { "SizeInMBs": integer, "IntervalInSeconds": integer }, "CompressionFormat": "UNCOMPRESSED"|"GZIP"|"ZIP"|"Snappy"|"HADOOP_SNAPPY", "EncryptionConfiguration": { "NoEncryptionConfig": "NoEncryption", "KMSEncryptionConfig": { "AWSKMSKeyARN": "string" } }, "CloudWatchLoggingOptions": { "Enabled": true|false, "LogGroupName": "string", "LogStreamName": "string" } }, "ProcessingConfiguration": { "Enabled": true|false, "Processors": [ { "Type": "RecordDeAggregation"|"Lambda"|"MetadataExtraction"|"AppendDelimiterToRecord", "Parameters": [ { "ParameterName": "LambdaArn"|"NumberOfRetries"|"MetadataExtractionQuery"|"JsonParsingEngine"|"RoleArn"|"BufferSizeInMBs"|"BufferIntervalInSeconds"|"SubRecordType"|"Delimiter", "ParameterValue": "string" } ... ] } ... ] }, "S3BackupMode": "Disabled"|"Enabled", "S3BackupUpdate": { "RoleARN": "string", "BucketARN": "string", "Prefix": "string", "ErrorOutputPrefix": "string", "BufferingHints": { "SizeInMBs": integer, "IntervalInSeconds": integer }, "CompressionFormat": "UNCOMPRESSED"|"GZIP"|"ZIP"|"Snappy"|"HADOOP_SNAPPY", "EncryptionConfiguration": { "NoEncryptionConfig": "NoEncryption", "KMSEncryptionConfig": { "AWSKMSKeyARN": "string" } }, "CloudWatchLoggingOptions": { "Enabled": true|false, "LogGroupName": "string", "LogStreamName": "string" } }, "CloudWatchLoggingOptions": { "Enabled": true|false, "LogGroupName": "string", "LogStreamName": "string" } }
--elasticsearch-destination-update(structure)Describes an update for a destination in Amazon ES.
RoleARN -> (string)
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
DomainARN -> (string)
The ARN of the Amazon ES domain. The IAM role must have permissions for
DescribeDomain,DescribeDomains, andDescribeDomainConfigafter assuming the IAM role specified inRoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .Specify either
ClusterEndpointorDomainARN.ClusterEndpoint -> (string)
The endpoint to use when communicating with the cluster. Specify either this
ClusterEndpointor theDomainARNfield.IndexName -> (string)
The Elasticsearch index name.
TypeName -> (string)
The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.
If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for
TypeName.IndexRotationPeriod -> (string)
The Elasticsearch index rotation period. Index rotation appends a timestamp to
IndexNameto facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination . Default value isOneDay.BufferingHints -> (structure)
The buffering options. If no value is specified,
ElasticsearchBufferingHintsobject default values are used.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 retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
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.
S3Update -> (structure)
The Amazon S3 destination.
RoleARN -> (string)
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
BucketARN -> (string)
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services 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,
BufferingHintsobject 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.The compression formats
SNAPPYorZIPcannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPYoperation that reads from the S3 bucket.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 Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
CloudWatchLoggingOptions -> (structure)
The 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. Currently the following default values are supported: 3 for
NumberOfRetriesand 60 for theBufferIntervalInSeconds. TheBufferSizeInMBsranges 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)
The parameter value.
CloudWatchLoggingOptions -> (structure)
The 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.
JSON Syntax:
{ "RoleARN": "string", "DomainARN": "string", "ClusterEndpoint": "string", "IndexName": "string", "TypeName": "string", "IndexRotationPeriod": "NoRotation"|"OneHour"|"OneDay"|"OneWeek"|"OneMonth", "BufferingHints": { "IntervalInSeconds": integer, "SizeInMBs": integer }, "RetryOptions": { "DurationInSeconds": integer }, "S3Update": { "RoleARN": "string", "BucketARN": "string", "Prefix": "string", "ErrorOutputPrefix": "string", "BufferingHints": { "SizeInMBs": integer, "IntervalInSeconds": integer }, "CompressionFormat": "UNCOMPRESSED"|"GZIP"|"ZIP"|"Snappy"|"HADOOP_SNAPPY", "EncryptionConfiguration": { "NoEncryptionConfig": "NoEncryption", "KMSEncryptionConfig": { "AWSKMSKeyARN": "string" } }, "CloudWatchLoggingOptions": { "Enabled": true|false, "LogGroupName": "string", "LogStreamName": "string" } }, "ProcessingConfiguration": { "Enabled": true|false, "Processors": [ { "Type": "RecordDeAggregation"|"Lambda"|"MetadataExtraction"|"AppendDelimiterToRecord", "Parameters": [ { "ParameterName": "LambdaArn"|"NumberOfRetries"|"MetadataExtractionQuery"|"JsonParsingEngine"|"RoleArn"|"BufferSizeInMBs"|"BufferIntervalInSeconds"|"SubRecordType"|"Delimiter", "ParameterValue": "string" } ... ] } ... ] }, "CloudWatchLoggingOptions": { "Enabled": true|false, "LogGroupName": "string", "LogStreamName": "string" } }
--amazonopensearchservice-destination-update(structure)Describes an update for a destination in Amazon OpenSearch Service.
RoleARN -> (string)
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
DomainARN -> (string)
The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.
ClusterEndpoint -> (string)
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
IndexName -> (string)
The Amazon OpenSearch Service index name.
TypeName -> (string)
The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.
If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
IndexRotationPeriod -> (string)
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
BufferingHints -> (structure)
The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
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 retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
DurationInSeconds -> (integer)
After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
S3Update -> (structure)
Describes an update for a destination in Amazon S3.
RoleARN -> (string)
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
BucketARN -> (string)
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services 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,
BufferingHintsobject 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.The compression formats
SNAPPYorZIPcannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPYoperation that reads from the S3 bucket.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 Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
CloudWatchLoggingOptions -> (structure)
The 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)
Describes a 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. Currently the following default values are supported: 3 for
NumberOfRetriesand 60 for theBufferIntervalInSeconds. TheBufferSizeInMBsranges 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)
The parameter value.
CloudWatchLoggingOptions -> (structure)
Describes 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.
JSON Syntax:
{ "RoleARN": "string", "DomainARN": "string", "ClusterEndpoint": "string", "IndexName": "string", "TypeName": "string", "IndexRotationPeriod": "NoRotation"|"OneHour"|"OneDay"|"OneWeek"|"OneMonth", "BufferingHints": { "IntervalInSeconds": integer, "SizeInMBs": integer }, "RetryOptions": { "DurationInSeconds": integer }, "S3Update": { "RoleARN": "string", "BucketARN": "string", "Prefix": "string", "ErrorOutputPrefix": "string", "BufferingHints": { "SizeInMBs": integer, "IntervalInSeconds": integer }, "CompressionFormat": "UNCOMPRESSED"|"GZIP"|"ZIP"|"Snappy"|"HADOOP_SNAPPY", "EncryptionConfiguration": { "NoEncryptionConfig": "NoEncryption", "KMSEncryptionConfig": { "AWSKMSKeyARN": "string" } }, "CloudWatchLoggingOptions": { "Enabled": true|false, "LogGroupName": "string", "LogStreamName": "string" } }, "ProcessingConfiguration": { "Enabled": true|false, "Processors": [ { "Type": "RecordDeAggregation"|"Lambda"|"MetadataExtraction"|"AppendDelimiterToRecord", "Parameters": [ { "ParameterName": "LambdaArn"|"NumberOfRetries"|"MetadataExtractionQuery"|"JsonParsingEngine"|"RoleArn"|"BufferSizeInMBs"|"BufferIntervalInSeconds"|"SubRecordType"|"Delimiter", "ParameterValue": "string" } ... ] } ... ] }, "CloudWatchLoggingOptions": { "Enabled": true|false, "LogGroupName": "string", "LogStreamName": "string" } }
--splunk-destination-update(structure)Describes an update for a 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 that 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 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)
Specifies how you want Kinesis Data Firehose to back up documents 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 toAllEvents, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value isFailedEventsOnly.You can update this backup mode from
FailedEventsOnlytoAllEvents. You can’t update it fromAllEventstoFailedEventsOnly.S3Update -> (structure)
Your update to the configuration of the backup Amazon S3 location.
RoleARN -> (string)
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
BucketARN -> (string)
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services 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,
BufferingHintsobject 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.The compression formats
SNAPPYorZIPcannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPYoperation that reads from the S3 bucket.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 Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
CloudWatchLoggingOptions -> (structure)
The 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. Currently the following default values are supported: 3 for
NumberOfRetriesand 60 for theBufferIntervalInSeconds. TheBufferSizeInMBsranges 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)
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.
JSON Syntax:
{ "HECEndpoint": "string", "HECEndpointType": "Raw"|"Event", "HECToken": "string", "HECAcknowledgmentTimeoutInSeconds": integer, "RetryOptions": { "DurationInSeconds": integer }, "S3BackupMode": "FailedEventsOnly"|"AllEvents", "S3Update": { "RoleARN": "string", "BucketARN": "string", "Prefix": "string", "ErrorOutputPrefix": "string", "BufferingHints": { "SizeInMBs": integer, "IntervalInSeconds": integer }, "CompressionFormat": "UNCOMPRESSED"|"GZIP"|"ZIP"|"Snappy"|"HADOOP_SNAPPY", "EncryptionConfiguration": { "NoEncryptionConfig": "NoEncryption", "KMSEncryptionConfig": { "AWSKMSKeyARN": "string" } }, "CloudWatchLoggingOptions": { "Enabled": true|false, "LogGroupName": "string", "LogStreamName": "string" } }, "ProcessingConfiguration": { "Enabled": true|false, "Processors": [ { "Type": "RecordDeAggregation"|"Lambda"|"MetadataExtraction"|"AppendDelimiterToRecord", "Parameters": [ { "ParameterName": "LambdaArn"|"NumberOfRetries"|"MetadataExtractionQuery"|"JsonParsingEngine"|"RoleArn"|"BufferSizeInMBs"|"BufferIntervalInSeconds"|"SubRecordType"|"Delimiter", "ParameterValue": "string" } ... ] } ... ] }, "CloudWatchLoggingOptions": { "Enabled": true|false, "LogGroupName": "string", "LogStreamName": "string" } }
--http-endpoint-destination-update(structure)Describes an update to the specified HTTP endpoint destination.
EndpointConfiguration -> (structure)
Describes the configuration of the HTTP endpoint destination.
Url -> (string)
The URL of the HTTP endpoint selected as the destination.
Warning
If you choose an HTTP endpoint as your destination, review and follow the instructions in the Appendix - HTTP Endpoint Delivery Request and Response Specifications .
Name -> (string)
The name of the HTTP endpoint selected as the destination.
AccessKey -> (string)
The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.
BufferingHints -> (structure)
Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Kinesis Data Firehose teats these options as hints, and it might choose to use more optimal values. The
SizeInMBsandIntervalInSecondsparameters 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 delivery 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)
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
CloudWatchLoggingOptions -> (structure)
Describes 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.
RequestConfiguration -> (structure)
The configuration of the request sent to the HTTP endpoint specified as the destination.
ContentEncoding -> (string)
Kinesis Data Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation.
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)
The name of the HTTP endpoint common attribute.
AttributeValue -> (string)
The value of the HTTP endpoint common attribute.
ProcessingConfiguration -> (structure)
Describes a 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. Currently the following default values are supported: 3 for
NumberOfRetriesand 60 for theBufferIntervalInSeconds. TheBufferSizeInMBsranges 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)
The parameter value.
RoleARN -> (string)
Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.
RetryOptions -> (structure)
Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn’t receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
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 the custom destination via HTTPS endpoint fails. It doesn’t include the periods during which Kinesis Data Firehose waits for acknowledgment from the specified destination after each attempt.
S3BackupMode -> (string)
Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (
AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).S3Update -> (structure)
Describes an update for a destination in Amazon S3.
RoleARN -> (string)
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
BucketARN -> (string)
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services 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,
BufferingHintsobject 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.The compression formats
SNAPPYorZIPcannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPYoperation that reads from the S3 bucket.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 Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
CloudWatchLoggingOptions -> (structure)
The 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.
JSON Syntax:
{ "EndpointConfiguration": { "Url": "string", "Name": "string", "AccessKey": "string" }, "BufferingHints": { "SizeInMBs": integer, "IntervalInSeconds": integer }, "CloudWatchLoggingOptions": { "Enabled": true|false, "LogGroupName": "string", "LogStreamName": "string" }, "RequestConfiguration": { "ContentEncoding": "NONE"|"GZIP", "CommonAttributes": [ { "AttributeName": "string", "AttributeValue": "string" } ... ] }, "ProcessingConfiguration": { "Enabled": true|false, "Processors": [ { "Type": "RecordDeAggregation"|"Lambda"|"MetadataExtraction"|"AppendDelimiterToRecord", "Parameters": [ { "ParameterName": "LambdaArn"|"NumberOfRetries"|"MetadataExtractionQuery"|"JsonParsingEngine"|"RoleArn"|"BufferSizeInMBs"|"BufferIntervalInSeconds"|"SubRecordType"|"Delimiter", "ParameterValue": "string" } ... ] } ... ] }, "RoleARN": "string", "RetryOptions": { "DurationInSeconds": integer }, "S3BackupMode": "FailedDataOnly"|"AllData", "S3Update": { "RoleARN": "string", "BucketARN": "string", "Prefix": "string", "ErrorOutputPrefix": "string", "BufferingHints": { "SizeInMBs": integer, "IntervalInSeconds": integer }, "CompressionFormat": "UNCOMPRESSED"|"GZIP"|"ZIP"|"Snappy"|"HADOOP_SNAPPY", "EncryptionConfiguration": { "NoEncryptionConfig": "NoEncryption", "KMSEncryptionConfig": { "AWSKMSKeyARN": "string" } }, "CloudWatchLoggingOptions": { "Enabled": true|false, "LogGroupName": "string", "LogStreamName": "string" } } }
--amazon-open-search-serverless-destination-update(structure)Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.
RoleARN -> (string)
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
CollectionEndpoint -> (string)
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
IndexName -> (string)
The Serverless offering for Amazon OpenSearch Service index name.
BufferingHints -> (structure)
The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
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 retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
DurationInSeconds -> (integer)
After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
S3Update -> (structure)
Describes an update for a destination in Amazon S3.
RoleARN -> (string)
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
BucketARN -> (string)
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services 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,
BufferingHintsobject 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.The compression formats
SNAPPYorZIPcannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPYoperation that reads from the S3 bucket.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 Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
CloudWatchLoggingOptions -> (structure)
The 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)
Describes a 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. Currently the following default values are supported: 3 for
NumberOfRetriesand 60 for theBufferIntervalInSeconds. TheBufferSizeInMBsranges 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)
The parameter value.
CloudWatchLoggingOptions -> (structure)
Describes 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.
JSON Syntax:
{ "RoleARN": "string", "CollectionEndpoint": "string", "IndexName": "string", "BufferingHints": { "IntervalInSeconds": integer, "SizeInMBs": integer }, "RetryOptions": { "DurationInSeconds": integer }, "S3Update": { "RoleARN": "string", "BucketARN": "string", "Prefix": "string", "ErrorOutputPrefix": "string", "BufferingHints": { "SizeInMBs": integer, "IntervalInSeconds": integer }, "CompressionFormat": "UNCOMPRESSED"|"GZIP"|"ZIP"|"Snappy"|"HADOOP_SNAPPY", "EncryptionConfiguration": { "NoEncryptionConfig": "NoEncryption", "KMSEncryptionConfig": { "AWSKMSKeyARN": "string" } }, "CloudWatchLoggingOptions": { "Enabled": true|false, "LogGroupName": "string", "LogStreamName": "string" } }, "ProcessingConfiguration": { "Enabled": true|false, "Processors": [ { "Type": "RecordDeAggregation"|"Lambda"|"MetadataExtraction"|"AppendDelimiterToRecord", "Parameters": [ { "ParameterName": "LambdaArn"|"NumberOfRetries"|"MetadataExtractionQuery"|"JsonParsingEngine"|"RoleArn"|"BufferSizeInMBs"|"BufferIntervalInSeconds"|"SubRecordType"|"Delimiter", "ParameterValue": "string" } ... ] } ... ] }, "CloudWatchLoggingOptions": { "Enabled": true|false, "LogGroupName": "string", "LogStreamName": "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 valueinput, prints a sample input JSON that can be used as an argument for--cli-input-json. Similarly, if providedyaml-inputit will print a sample input YAML that can be used with--cli-input-yaml. If provided with the valueoutput, 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.
--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 thecli-binary-formatsetting. When usingfile://the file contents will need to properly formatted for the configuredcli-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¶
None