Interface CfnDeliveryStream.IAmazonOpenSearchServerlessDestinationConfigurationProperty
Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
Namespace: Amazon.CDK.AWS.KinesisFirehose
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IAmazonOpenSearchServerlessDestinationConfigurationProperty
Syntax (vb)
Public Interface IAmazonOpenSearchServerlessDestinationConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.KinesisFirehose;
var amazonOpenSearchServerlessDestinationConfigurationProperty = new AmazonOpenSearchServerlessDestinationConfigurationProperty {
IndexName = "indexName",
RoleArn = "roleArn",
S3Configuration = new S3DestinationConfigurationProperty {
BucketArn = "bucketArn",
RoleArn = "roleArn",
// the properties below are optional
BufferingHints = new BufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
CompressionFormat = "compressionFormat",
EncryptionConfiguration = new EncryptionConfigurationProperty {
KmsEncryptionConfig = new KMSEncryptionConfigProperty {
AwskmsKeyArn = "awskmsKeyArn"
},
NoEncryptionConfig = "noEncryptionConfig"
},
ErrorOutputPrefix = "errorOutputPrefix",
Prefix = "prefix"
},
// the properties below are optional
BufferingHints = new AmazonOpenSearchServerlessBufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
CollectionEndpoint = "collectionEndpoint",
ProcessingConfiguration = new ProcessingConfigurationProperty {
Enabled = false,
Processors = new [] { new ProcessorProperty {
Type = "type",
// the properties below are optional
Parameters = new [] { new ProcessorParameterProperty {
ParameterName = "parameterName",
ParameterValue = "parameterValue"
} }
} }
},
RetryOptions = new AmazonOpenSearchServerlessRetryOptionsProperty {
DurationInSeconds = 123
},
S3BackupMode = "s3BackupMode",
VpcConfiguration = new VpcConfigurationProperty {
RoleArn = "roleArn",
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
};
Synopsis
Properties
BufferingHints | The buffering options. |
CloudWatchLoggingOptions | |
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 | |
RetryOptions | The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. |
RoleArn | The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents. |
S3BackupMode | Defines how documents should be delivered to Amazon S3. |
S3Configuration | |
VpcConfiguration |
Properties
BufferingHints
The buffering options.
virtual object BufferingHints { get; }
Property Value
System.Object
Remarks
If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
CloudWatchLoggingOptions
virtual object CloudWatchLoggingOptions { get; }
Property Value
System.Object
Remarks
CollectionEndpoint
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
virtual string CollectionEndpoint { get; }
Property Value
System.String
Remarks
IndexName
The Serverless offering for Amazon OpenSearch Service index name.
string IndexName { get; }
Property Value
System.String
Remarks
ProcessingConfiguration
virtual object ProcessingConfiguration { get; }
Property Value
System.Object
Remarks
RetryOptions
The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
virtual object RetryOptions { get; }
Property Value
System.Object
Remarks
The default value is 300 (5 minutes).
RoleArn
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
string RoleArn { get; }
Property Value
System.String
Remarks
S3BackupMode
Defines how documents should be delivered to Amazon S3.
virtual string S3BackupMode { get; }
Property Value
System.String
Remarks
When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
S3Configuration
object S3Configuration { get; }
Property Value
System.Object
Remarks
VpcConfiguration
virtual object VpcConfiguration { get; }
Property Value
System.Object