FirehoseDeliveryStreamOpensearchserverlessConfiguration class

Constructors

FirehoseDeliveryStreamOpensearchserverlessConfiguration({Input<int?>? bufferingInterval, Input<int?>? bufferingSize, Input<FirehoseDeliveryStreamOpensearchserverlessConfigurationCloudwatchLoggingOptions?>? cloudwatchLoggingOptions, required Input<String> collectionEndpoint, required Input<String> indexName, Input<FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfiguration?>? processingConfiguration, Input<int?>? retryDuration, required Input<String> roleArn, Input<String?>? s3BackupMode, required Input<FirehoseDeliveryStreamOpensearchserverlessConfigurationS3Configuration> s3Configuration, Input<FirehoseDeliveryStreamOpensearchserverlessConfigurationVpcConfig?>? vpcConfig})
Creates a new FirehoseDeliveryStreamOpensearchserverlessConfiguration. bufferingInterval Buffer incoming data for the specified period of time, in seconds between 0 to 900, before delivering it to the destination. The default value is 300s. bufferingSize Buffer incoming data to the specified size, in MBs between 1 to 100, before delivering it to the destination. The default value is 5MB. cloudwatchLoggingOptions The CloudWatch Logging Options for the delivery stream. See cloudwatchLoggingOptions block below for details. collectionEndpoint The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service. indexName The Serverless offering for Amazon OpenSearch Service index name. processingConfiguration The data processing configuration. See processingConfiguration block below for details. retryDuration After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time, in seconds between 0 to 7200, during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. The default value is 300s. There will be no retry if the value is 0. roleArn 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. The pattern needs to be arn:.*. s3BackupMode Defines how documents should be delivered to Amazon S3. Valid values are FailedDocumentsOnly and AllDocuments. Default value is FailedDocumentsOnly. s3Configuration The S3 Configuration. See s3Configuration block below for details. vpcConfig The VPC configuration for the delivery stream to connect to OpenSearch Serverless associated with the VPC. See vpcConfig block below for details.
const
FirehoseDeliveryStreamOpensearchserverlessConfiguration.fromMap(Map<String, dynamic> map)
factory

Properties

bufferingInterval → Input<int?>?
Buffer incoming data for the specified period of time, in seconds between 0 to 900, before delivering it to the destination. The default value is 300s.
final
bufferingSize → Input<int?>?
Buffer incoming data to the specified size, in MBs between 1 to 100, before delivering it to the destination. The default value is 5MB.
final
cloudwatchLoggingOptions → Input<FirehoseDeliveryStreamOpensearchserverlessConfigurationCloudwatchLoggingOptions?>?
The CloudWatch Logging Options for the delivery stream. See cloudwatchLoggingOptions block below for details.
final
collectionEndpoint → Input<String>
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
final
hashCode → int
The hash code for this object.
no setterinherited
indexName → Input<String>
The Serverless offering for Amazon OpenSearch Service index name.
final
processingConfiguration → Input<FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfiguration?>?
The data processing configuration. See processingConfiguration block below for details.
final
retryDuration → Input<int?>?
After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time, in seconds between 0 to 7200, during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. The default value is 300s. There will be no retry if the value is 0.
final
roleArn → Input<String>
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. The pattern needs to be arn:.*.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
s3BackupMode → Input<String?>?
Defines how documents should be delivered to Amazon S3. Valid values are FailedDocumentsOnly and AllDocuments. Default value is FailedDocumentsOnly.
final
s3Configuration → Input<FirehoseDeliveryStreamOpensearchserverlessConfigurationS3Configuration>
The S3 Configuration. See s3Configuration block below for details.
final
vpcConfig → Input<FirehoseDeliveryStreamOpensearchserverlessConfigurationVpcConfig?>?
The VPC configuration for the delivery stream to connect to OpenSearch Serverless associated with the VPC. See vpcConfig block below for details.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited