interface AmazonOpenSearchServerlessDestinationConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.KinesisFirehose.CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskinesisfirehose#CfnDeliveryStream_AmazonOpenSearchServerlessDestinationConfigurationProperty`
Java	`software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty`
Python	`aws_cdk.aws_kinesisfirehose.CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_kinesisfirehose` » `CfnDeliveryStream` » `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 { aws_kinesisfirehose as kinesisfirehose } from 'aws-cdk-lib';
const amazonOpenSearchServerlessDestinationConfigurationProperty: kinesisfirehose.CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty = {
  indexName: 'indexName',
  roleArn: 'roleArn',
  s3Configuration: {
    bucketArn: 'bucketArn',
    roleArn: 'roleArn',

    // the properties below are optional
    bufferingHints: {
      intervalInSeconds: 123,
      sizeInMBs: 123,
    },
    cloudWatchLoggingOptions: {
      enabled: false,
      logGroupName: 'logGroupName',
      logStreamName: 'logStreamName',
    },
    compressionFormat: 'compressionFormat',
    encryptionConfiguration: {
      kmsEncryptionConfig: {
        awskmsKeyArn: 'awskmsKeyArn',
      },
      noEncryptionConfig: 'noEncryptionConfig',
    },
    errorOutputPrefix: 'errorOutputPrefix',
    prefix: 'prefix',
  },

  // the properties below are optional
  bufferingHints: {
    intervalInSeconds: 123,
    sizeInMBs: 123,
  },
  cloudWatchLoggingOptions: {
    enabled: false,
    logGroupName: 'logGroupName',
    logStreamName: 'logStreamName',
  },
  collectionEndpoint: 'collectionEndpoint',
  processingConfiguration: {
    enabled: false,
    processors: [{
      type: 'type',

      // the properties below are optional
      parameters: [{
        parameterName: 'parameterName',
        parameterValue: 'parameterValue',
      }],
    }],
  },
  retryOptions: {
    durationInSeconds: 123,
  },
  s3BackupMode: 's3BackupMode',
  vpcConfiguration: {
    roleArn: 'roleArn',
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
  },
};

Properties

Name	Type	Description
indexName	`string`	The Serverless offering for Amazon OpenSearch Service index name.
roleArn	`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.
s3Configuration	`IResolvable` `\|` `S3DestinationConfigurationProperty`
bufferingHints?	`IResolvable` `\|` `AmazonOpenSearchServerlessBufferingHintsProperty`	The buffering options.
cloudWatchLoggingOptions?	`IResolvable` `\|` `CloudWatchLoggingOptionsProperty`
collectionEndpoint?	`string`	The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
processingConfiguration?	`IResolvable` `\|` `ProcessingConfigurationProperty`
retryOptions?	`IResolvable` `\|` `AmazonOpenSearchServerlessRetryOptionsProperty`	The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
s3BackupMode?	`string`	Defines how documents should be delivered to Amazon S3.
vpcConfiguration?	`IResolvable` `\|` `VpcConfigurationProperty`

indexName

Type: string

The Serverless offering for Amazon OpenSearch Service index name.

roleArn

Type: 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.

s3Configuration

Type: IResolvable | S3DestinationConfigurationProperty

bufferingHints?

Type: IResolvable | AmazonOpenSearchServerlessBufferingHintsProperty (optional)

The buffering options.

If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.

cloudWatchLoggingOptions?

Type: IResolvable | CloudWatchLoggingOptionsProperty (optional)

collectionEndpoint?

Type: string (optional)

The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

processingConfiguration?

Type: IResolvable | ProcessingConfigurationProperty (optional)

retryOptions?

Type: IResolvable | AmazonOpenSearchServerlessRetryOptionsProperty (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).

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.

vpcConfiguration?

Type: IResolvable | VpcConfigurationProperty (optional)