AWS.Firehose — AWS SDK for JavaScript (original) (raw)
Examples:
Calling the createDeliveryStream operation
var params = {
DeliveryStreamName: 'STRING_VALUE', /* required */
AmazonOpenSearchServerlessDestinationConfiguration: {
IndexName: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE', /* required */
S3Configuration: { /* required */
BucketARN: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE', /* required */
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy | HADOOP_SNAPPY,
EncryptionConfiguration: {
KMSEncryptionConfig: {
AWSKMSKeyARN: 'STRING_VALUE' /* required */
},
NoEncryptionConfig: NoEncryption
},
ErrorOutputPrefix: 'STRING_VALUE',
Prefix: 'STRING_VALUE'
},
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
CollectionEndpoint: 'STRING_VALUE',
ProcessingConfiguration: {
Enabled: true || false,
Processors: [
{
Type: RecordDeAggregation | Decompression | CloudWatchLogProcessing | Lambda | MetadataExtraction | AppendDelimiterToRecord, /* required */
Parameters: [
{
ParameterName: LambdaArn | NumberOfRetries | MetadataExtractionQuery | JsonParsingEngine | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds | SubRecordType | Delimiter | CompressionFormat | DataMessageExtraction, /* required */
ParameterValue: 'STRING_VALUE' /* required */
},
/* more items */
]
},
/* more items */
]
},
RetryOptions: {
DurationInSeconds: 'NUMBER_VALUE'
},
S3BackupMode: FailedDocumentsOnly | AllDocuments,
VpcConfiguration: {
RoleARN: 'STRING_VALUE', /* required */
SecurityGroupIds: [ /* required */
'STRING_VALUE',
/* more items */
],
SubnetIds: [ /* required */
'STRING_VALUE',
/* more items */
]
}
},
AmazonopensearchserviceDestinationConfiguration: {
IndexName: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE', /* required */
S3Configuration: { /* required */
BucketARN: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE', /* required */
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy | HADOOP_SNAPPY,
EncryptionConfiguration: {
KMSEncryptionConfig: {
AWSKMSKeyARN: 'STRING_VALUE' /* required */
},
NoEncryptionConfig: NoEncryption
},
ErrorOutputPrefix: 'STRING_VALUE',
Prefix: 'STRING_VALUE'
},
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
ClusterEndpoint: 'STRING_VALUE',
DocumentIdOptions: {
DefaultDocumentIdFormat: FIREHOSE_DEFAULT | NO_DOCUMENT_ID /* required */
},
DomainARN: 'STRING_VALUE',
IndexRotationPeriod: NoRotation | OneHour | OneDay | OneWeek | OneMonth,
ProcessingConfiguration: {
Enabled: true || false,
Processors: [
{
Type: RecordDeAggregation | Decompression | CloudWatchLogProcessing | Lambda | MetadataExtraction | AppendDelimiterToRecord, /* required */
Parameters: [
{
ParameterName: LambdaArn | NumberOfRetries | MetadataExtractionQuery | JsonParsingEngine | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds | SubRecordType | Delimiter | CompressionFormat | DataMessageExtraction, /* required */
ParameterValue: 'STRING_VALUE' /* required */
},
/* more items */
]
},
/* more items */
]
},
RetryOptions: {
DurationInSeconds: 'NUMBER_VALUE'
},
S3BackupMode: FailedDocumentsOnly | AllDocuments,
TypeName: 'STRING_VALUE',
VpcConfiguration: {
RoleARN: 'STRING_VALUE', /* required */
SecurityGroupIds: [ /* required */
'STRING_VALUE',
/* more items */
],
SubnetIds: [ /* required */
'STRING_VALUE',
/* more items */
]
}
},
DeliveryStreamEncryptionConfigurationInput: {
KeyType: AWS_OWNED_CMK | CUSTOMER_MANAGED_CMK, /* required */
KeyARN: 'STRING_VALUE'
},
DeliveryStreamType: DirectPut | KinesisStreamAsSource | MSKAsSource,
ElasticsearchDestinationConfiguration: {
IndexName: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE', /* required */
S3Configuration: { /* required */
BucketARN: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE', /* required */
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy | HADOOP_SNAPPY,
EncryptionConfiguration: {
KMSEncryptionConfig: {
AWSKMSKeyARN: 'STRING_VALUE' /* required */
},
NoEncryptionConfig: NoEncryption
},
ErrorOutputPrefix: 'STRING_VALUE',
Prefix: 'STRING_VALUE'
},
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
ClusterEndpoint: 'STRING_VALUE',
DocumentIdOptions: {
DefaultDocumentIdFormat: FIREHOSE_DEFAULT | NO_DOCUMENT_ID /* required */
},
DomainARN: 'STRING_VALUE',
IndexRotationPeriod: NoRotation | OneHour | OneDay | OneWeek | OneMonth,
ProcessingConfiguration: {
Enabled: true || false,
Processors: [
{
Type: RecordDeAggregation | Decompression | CloudWatchLogProcessing | Lambda | MetadataExtraction | AppendDelimiterToRecord, /* required */
Parameters: [
{
ParameterName: LambdaArn | NumberOfRetries | MetadataExtractionQuery | JsonParsingEngine | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds | SubRecordType | Delimiter | CompressionFormat | DataMessageExtraction, /* required */
ParameterValue: 'STRING_VALUE' /* required */
},
/* more items */
]
},
/* more items */
]
},
RetryOptions: {
DurationInSeconds: 'NUMBER_VALUE'
},
S3BackupMode: FailedDocumentsOnly | AllDocuments,
TypeName: 'STRING_VALUE',
VpcConfiguration: {
RoleARN: 'STRING_VALUE', /* required */
SecurityGroupIds: [ /* required */
'STRING_VALUE',
/* more items */
],
SubnetIds: [ /* required */
'STRING_VALUE',
/* more items */
]
}
},
ExtendedS3DestinationConfiguration: {
BucketARN: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE', /* required */
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy | HADOOP_SNAPPY,
CustomTimeZone: 'STRING_VALUE',
DataFormatConversionConfiguration: {
Enabled: true || false,
InputFormatConfiguration: {
Deserializer: {
HiveJsonSerDe: {
TimestampFormats: [
'STRING_VALUE',
/* more items */
]
},
OpenXJsonSerDe: {
CaseInsensitive: true || false,
ColumnToJsonKeyMappings: {
'<NonEmptyStringWithoutWhitespace>': 'STRING_VALUE',
/* '<NonEmptyStringWithoutWhitespace>': ... */
},
ConvertDotsInJsonKeysToUnderscores: true || false
}
}
},
OutputFormatConfiguration: {
Serializer: {
OrcSerDe: {
BlockSizeBytes: 'NUMBER_VALUE',
BloomFilterColumns: [
'STRING_VALUE',
/* more items */
],
BloomFilterFalsePositiveProbability: 'NUMBER_VALUE',
Compression: NONE | ZLIB | SNAPPY,
DictionaryKeyThreshold: 'NUMBER_VALUE',
EnablePadding: true || false,
FormatVersion: V0_11 | V0_12,
PaddingTolerance: 'NUMBER_VALUE',
RowIndexStride: 'NUMBER_VALUE',
StripeSizeBytes: 'NUMBER_VALUE'
},
ParquetSerDe: {
BlockSizeBytes: 'NUMBER_VALUE',
Compression: UNCOMPRESSED | GZIP | SNAPPY,
EnableDictionaryCompression: true || false,
MaxPaddingBytes: 'NUMBER_VALUE',
PageSizeBytes: 'NUMBER_VALUE',
WriterVersion: V1 | V2
}
}
},
SchemaConfiguration: {
CatalogId: 'STRING_VALUE',
DatabaseName: 'STRING_VALUE',
Region: 'STRING_VALUE',
RoleARN: 'STRING_VALUE',
TableName: 'STRING_VALUE',
VersionId: 'STRING_VALUE'
}
},
DynamicPartitioningConfiguration: {
Enabled: true || false,
RetryOptions: {
DurationInSeconds: 'NUMBER_VALUE'
}
},
EncryptionConfiguration: {
KMSEncryptionConfig: {
AWSKMSKeyARN: 'STRING_VALUE' /* required */
},
NoEncryptionConfig: NoEncryption
},
ErrorOutputPrefix: 'STRING_VALUE',
FileExtension: 'STRING_VALUE',
Prefix: 'STRING_VALUE',
ProcessingConfiguration: {
Enabled: true || false,
Processors: [
{
Type: RecordDeAggregation | Decompression | CloudWatchLogProcessing | Lambda | MetadataExtraction | AppendDelimiterToRecord, /* required */
Parameters: [
{
ParameterName: LambdaArn | NumberOfRetries | MetadataExtractionQuery | JsonParsingEngine | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds | SubRecordType | Delimiter | CompressionFormat | DataMessageExtraction, /* required */
ParameterValue: 'STRING_VALUE' /* required */
},
/* more items */
]
},
/* more items */
]
},
S3BackupConfiguration: {
BucketARN: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE', /* required */
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy | HADOOP_SNAPPY,
EncryptionConfiguration: {
KMSEncryptionConfig: {
AWSKMSKeyARN: 'STRING_VALUE' /* required */
},
NoEncryptionConfig: NoEncryption
},
ErrorOutputPrefix: 'STRING_VALUE',
Prefix: 'STRING_VALUE'
},
S3BackupMode: Disabled | Enabled
},
HttpEndpointDestinationConfiguration: {
EndpointConfiguration: { /* required */
Url: 'STRING_VALUE', /* required */
AccessKey: 'STRING_VALUE',
Name: 'STRING_VALUE'
},
S3Configuration: { /* required */
BucketARN: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE', /* required */
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy | HADOOP_SNAPPY,
EncryptionConfiguration: {
KMSEncryptionConfig: {
AWSKMSKeyARN: 'STRING_VALUE' /* required */
},
NoEncryptionConfig: NoEncryption
},
ErrorOutputPrefix: 'STRING_VALUE',
Prefix: 'STRING_VALUE'
},
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
ProcessingConfiguration: {
Enabled: true || false,
Processors: [
{
Type: RecordDeAggregation | Decompression | CloudWatchLogProcessing | Lambda | MetadataExtraction | AppendDelimiterToRecord, /* required */
Parameters: [
{
ParameterName: LambdaArn | NumberOfRetries | MetadataExtractionQuery | JsonParsingEngine | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds | SubRecordType | Delimiter | CompressionFormat | DataMessageExtraction, /* required */
ParameterValue: 'STRING_VALUE' /* required */
},
/* more items */
]
},
/* more items */
]
},
RequestConfiguration: {
CommonAttributes: [
{
AttributeName: 'STRING_VALUE', /* required */
AttributeValue: 'STRING_VALUE' /* required */
},
/* more items */
],
ContentEncoding: NONE | GZIP
},
RetryOptions: {
DurationInSeconds: 'NUMBER_VALUE'
},
RoleARN: 'STRING_VALUE',
S3BackupMode: FailedDataOnly | AllData,
SecretsManagerConfiguration: {
Enabled: true || false, /* required */
RoleARN: 'STRING_VALUE',
SecretARN: 'STRING_VALUE'
}
},
IcebergDestinationConfiguration: {
CatalogConfiguration: { /* required */
CatalogARN: 'STRING_VALUE'
},
RoleARN: 'STRING_VALUE', /* required */
S3Configuration: { /* required */
BucketARN: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE', /* required */
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy | HADOOP_SNAPPY,
EncryptionConfiguration: {
KMSEncryptionConfig: {
AWSKMSKeyARN: 'STRING_VALUE' /* required */
},
NoEncryptionConfig: NoEncryption
},
ErrorOutputPrefix: 'STRING_VALUE',
Prefix: 'STRING_VALUE'
},
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
DestinationTableConfigurationList: [
{
DestinationDatabaseName: 'STRING_VALUE', /* required */
DestinationTableName: 'STRING_VALUE', /* required */
S3ErrorOutputPrefix: 'STRING_VALUE',
UniqueKeys: [
'STRING_VALUE',
/* more items */
]
},
/* more items */
],
ProcessingConfiguration: {
Enabled: true || false,
Processors: [
{
Type: RecordDeAggregation | Decompression | CloudWatchLogProcessing | Lambda | MetadataExtraction | AppendDelimiterToRecord, /* required */
Parameters: [
{
ParameterName: LambdaArn | NumberOfRetries | MetadataExtractionQuery | JsonParsingEngine | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds | SubRecordType | Delimiter | CompressionFormat | DataMessageExtraction, /* required */
ParameterValue: 'STRING_VALUE' /* required */
},
/* more items */
]
},
/* more items */
]
},
RetryOptions: {
DurationInSeconds: 'NUMBER_VALUE'
},
S3BackupMode: FailedDataOnly | AllData
},
KinesisStreamSourceConfiguration: {
KinesisStreamARN: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE' /* required */
},
MSKSourceConfiguration: {
AuthenticationConfiguration: { /* required */
Connectivity: PUBLIC | PRIVATE, /* required */
RoleARN: 'STRING_VALUE' /* required */
},
MSKClusterARN: 'STRING_VALUE', /* required */
TopicName: 'STRING_VALUE', /* required */
ReadFromTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
},
RedshiftDestinationConfiguration: {
ClusterJDBCURL: 'STRING_VALUE', /* required */
CopyCommand: { /* required */
DataTableName: 'STRING_VALUE', /* required */
CopyOptions: 'STRING_VALUE',
DataTableColumns: 'STRING_VALUE'
},
RoleARN: 'STRING_VALUE', /* required */
S3Configuration: { /* required */
BucketARN: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE', /* required */
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy | HADOOP_SNAPPY,
EncryptionConfiguration: {
KMSEncryptionConfig: {
AWSKMSKeyARN: 'STRING_VALUE' /* required */
},
NoEncryptionConfig: NoEncryption
},
ErrorOutputPrefix: 'STRING_VALUE',
Prefix: 'STRING_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
Password: 'STRING_VALUE',
ProcessingConfiguration: {
Enabled: true || false,
Processors: [
{
Type: RecordDeAggregation | Decompression | CloudWatchLogProcessing | Lambda | MetadataExtraction | AppendDelimiterToRecord, /* required */
Parameters: [
{
ParameterName: LambdaArn | NumberOfRetries | MetadataExtractionQuery | JsonParsingEngine | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds | SubRecordType | Delimiter | CompressionFormat | DataMessageExtraction, /* required */
ParameterValue: 'STRING_VALUE' /* required */
},
/* more items */
]
},
/* more items */
]
},
RetryOptions: {
DurationInSeconds: 'NUMBER_VALUE'
},
S3BackupConfiguration: {
BucketARN: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE', /* required */
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy | HADOOP_SNAPPY,
EncryptionConfiguration: {
KMSEncryptionConfig: {
AWSKMSKeyARN: 'STRING_VALUE' /* required */
},
NoEncryptionConfig: NoEncryption
},
ErrorOutputPrefix: 'STRING_VALUE',
Prefix: 'STRING_VALUE'
},
S3BackupMode: Disabled | Enabled,
SecretsManagerConfiguration: {
Enabled: true || false, /* required */
RoleARN: 'STRING_VALUE',
SecretARN: 'STRING_VALUE'
},
Username: 'STRING_VALUE'
},
S3DestinationConfiguration: {
BucketARN: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE', /* required */
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy | HADOOP_SNAPPY,
EncryptionConfiguration: {
KMSEncryptionConfig: {
AWSKMSKeyARN: 'STRING_VALUE' /* required */
},
NoEncryptionConfig: NoEncryption
},
ErrorOutputPrefix: 'STRING_VALUE',
Prefix: 'STRING_VALUE'
},
SnowflakeDestinationConfiguration: {
AccountUrl: 'STRING_VALUE', /* required */
Database: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE', /* required */
S3Configuration: { /* required */
BucketARN: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE', /* required */
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy | HADOOP_SNAPPY,
EncryptionConfiguration: {
KMSEncryptionConfig: {
AWSKMSKeyARN: 'STRING_VALUE' /* required */
},
NoEncryptionConfig: NoEncryption
},
ErrorOutputPrefix: 'STRING_VALUE',
Prefix: 'STRING_VALUE'
},
Schema: 'STRING_VALUE', /* required */
Table: 'STRING_VALUE', /* required */
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
ContentColumnName: 'STRING_VALUE',
DataLoadingOption: JSON_MAPPING | VARIANT_CONTENT_MAPPING | VARIANT_CONTENT_AND_METADATA_MAPPING,
KeyPassphrase: 'STRING_VALUE',
MetaDataColumnName: 'STRING_VALUE',
PrivateKey: 'STRING_VALUE',
ProcessingConfiguration: {
Enabled: true || false,
Processors: [
{
Type: RecordDeAggregation | Decompression | CloudWatchLogProcessing | Lambda | MetadataExtraction | AppendDelimiterToRecord, /* required */
Parameters: [
{
ParameterName: LambdaArn | NumberOfRetries | MetadataExtractionQuery | JsonParsingEngine | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds | SubRecordType | Delimiter | CompressionFormat | DataMessageExtraction, /* required */
ParameterValue: 'STRING_VALUE' /* required */
},
/* more items */
]
},
/* more items */
]
},
RetryOptions: {
DurationInSeconds: 'NUMBER_VALUE'
},
S3BackupMode: FailedDataOnly | AllData,
SecretsManagerConfiguration: {
Enabled: true || false, /* required */
RoleARN: 'STRING_VALUE',
SecretARN: 'STRING_VALUE'
},
SnowflakeRoleConfiguration: {
Enabled: true || false,
SnowflakeRole: 'STRING_VALUE'
},
SnowflakeVpcConfiguration: {
PrivateLinkVpceId: 'STRING_VALUE' /* required */
},
User: 'STRING_VALUE'
},
SplunkDestinationConfiguration: {
HECEndpoint: 'STRING_VALUE', /* required */
HECEndpointType: Raw | Event, /* required */
S3Configuration: { /* required */
BucketARN: 'STRING_VALUE', /* required */
RoleARN: 'STRING_VALUE', /* required */
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy | HADOOP_SNAPPY,
EncryptionConfiguration: {
KMSEncryptionConfig: {
AWSKMSKeyARN: 'STRING_VALUE' /* required */
},
NoEncryptionConfig: NoEncryption
},
ErrorOutputPrefix: 'STRING_VALUE',
Prefix: 'STRING_VALUE'
},
BufferingHints: {
IntervalInSeconds: 'NUMBER_VALUE',
SizeInMBs: 'NUMBER_VALUE'
},
CloudWatchLoggingOptions: {
Enabled: true || false,
LogGroupName: 'STRING_VALUE',
LogStreamName: 'STRING_VALUE'
},
HECAcknowledgmentTimeoutInSeconds: 'NUMBER_VALUE',
HECToken: 'STRING_VALUE',
ProcessingConfiguration: {
Enabled: true || false,
Processors: [
{
Type: RecordDeAggregation | Decompression | CloudWatchLogProcessing | Lambda | MetadataExtraction | AppendDelimiterToRecord, /* required */
Parameters: [
{
ParameterName: LambdaArn | NumberOfRetries | MetadataExtractionQuery | JsonParsingEngine | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds | SubRecordType | Delimiter | CompressionFormat | DataMessageExtraction, /* required */
ParameterValue: 'STRING_VALUE' /* required */
},
/* more items */
]
},
/* more items */
]
},
RetryOptions: {
DurationInSeconds: 'NUMBER_VALUE'
},
S3BackupMode: FailedEventsOnly | AllEvents,
SecretsManagerConfiguration: {
Enabled: true || false, /* required */
RoleARN: 'STRING_VALUE',
SecretARN: 'STRING_VALUE'
}
},
Tags: [
{
Key: 'STRING_VALUE', /* required */
Value: 'STRING_VALUE'
},
/* more items */
]
};
firehose.createDeliveryStream(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});