interface AmazonOpenSearchServerlessDestinationConfigurationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.KinesisFirehose.Mixins.CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awskinesisfirehose/mixins#CfnDeliveryStreamPropsMixin_AmazonOpenSearchServerlessDestinationConfigurationProperty |
 Java | software.amazon.awscdk.mixins.preview.services.kinesisfirehose.mixins.CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty |
 Python | aws_cdk.mixins_preview.aws_kinesisfirehose.mixins.CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty |
 TypeScript | @aws-cdk/mixins-preview » aws_kinesisfirehose » mixins » CfnDeliveryStreamPropsMixin » AmazonOpenSearchServerlessDestinationConfigurationProperty |
Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as kinesisfirehose_mixins } from '@aws-cdk/mixins-preview/aws-kinesisfirehose';
const amazonOpenSearchServerlessDestinationConfigurationProperty: kinesisfirehose_mixins.CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty = {
bufferingHints: {
intervalInSeconds: 123,
sizeInMBs: 123,
},
cloudWatchLoggingOptions: {
enabled: false,
logGroupName: 'logGroupName',
logStreamName: 'logStreamName',
},
collectionEndpoint: 'collectionEndpoint',
indexName: 'indexName',
processingConfiguration: {
enabled: false,
processors: [{
parameters: [{
parameterName: 'parameterName',
parameterValue: 'parameterValue',
}],
type: 'type',
}],
},
retryOptions: {
durationInSeconds: 123,
},
roleArn: 'roleArn',
s3BackupMode: 's3BackupMode',
s3Configuration: {
bucketArn: 'bucketArn',
bufferingHints: {
intervalInSeconds: 123,
sizeInMBs: 123,
},
cloudWatchLoggingOptions: {
enabled: false,
logGroupName: 'logGroupName',
logStreamName: 'logStreamName',
},
compressionFormat: 'compressionFormat',
encryptionConfiguration: {
kmsEncryptionConfig: {
awskmsKeyArn: 'awskmsKeyArn',
},
noEncryptionConfig: 'noEncryptionConfig',
},
errorOutputPrefix: 'errorOutputPrefix',
prefix: 'prefix',
roleArn: 'roleArn',
},
vpcConfiguration: {
roleArn: 'roleArn',
securityGroupIds: ['securityGroupIds'],
subnetIds: ['subnetIds'],
},
};
Properties
| Name | Type | Description |
|---|---|---|
| buffering | IResolvable | Amazon | The buffering options. |
| cloud | IResolvable | Cloud | |
| collection | string | The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service. |
| index | string | The Serverless offering for Amazon OpenSearch Service index name. |
| processing | IResolvable | Processing | |
| retry | IResolvable | Amazon | The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. |
| role | string | 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. |
| s3 | string | Defines how documents should be delivered to Amazon S3. |
| s3 | IResolvable | S3 | |
| vpc | IResolvable | Vpc |
bufferingHints?
Type:
IResolvable | Amazon
(optional)
The buffering options.
If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
cloudWatchLoggingOptions?
Type:
IResolvable | Cloud
(optional)
collectionEndpoint?
Type:
string
(optional)
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
indexName?
Type:
string
(optional)
The Serverless offering for Amazon OpenSearch Service index name.
processingConfiguration?
Type:
IResolvable | Processing
(optional)
retryOptions?
Type:
IResolvable | Amazon
(optional)
The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
The default value is 300 (5 minutes).
roleArn?
Type:
string
(optional)
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?
Type:
string
(optional)
Defines how documents should be delivered to Amazon S3.
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?
Type:
IResolvable | S3
(optional)
vpcConfiguration?
Type:
IResolvable | Vpc
(optional)