aws-cdk-lib.aws_kinesisfirehose.CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

interface AmazonopensearchserviceDestinationConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.KinesisFirehose.CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskinesisfirehose#CfnDeliveryStream_AmazonopensearchserviceDestinationConfigurationProperty
Javasoftware.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty
Pythonaws_cdk.aws_kinesisfirehose.CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty
TypeScript aws-cdk-lib » aws_kinesisfirehose » CfnDeliveryStream » AmazonopensearchserviceDestinationConfigurationProperty

Describes the configuration of a destination in 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 amazonopensearchserviceDestinationConfigurationProperty: kinesisfirehose.CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty = {
  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',
  },
  clusterEndpoint: 'clusterEndpoint',
  documentIdOptions: {
    defaultDocumentIdFormat: 'defaultDocumentIdFormat',
  },
  domainArn: 'domainArn',
  indexRotationPeriod: 'indexRotationPeriod',
  processingConfiguration: {
    enabled: false,
    processors: [{
      type: 'type',

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

Properties

NameTypeDescription
indexNamestringThe Amazon OpenSearch Service index name.
roleArnstringThe Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
s3ConfigurationIResolvable | S3DestinationConfigurationPropertyDescribes the configuration of a destination in Amazon S3.
bufferingHints?IResolvable | AmazonopensearchserviceBufferingHintsPropertyThe buffering options.
cloudWatchLoggingOptions?IResolvable | CloudWatchLoggingOptionsPropertyDescribes the Amazon CloudWatch logging options for your delivery stream.
clusterEndpoint?stringThe endpoint to use when communicating with the cluster.
documentIdOptions?IResolvable | DocumentIdOptionsPropertyCfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.DocumentIdOptions.
domainArn?stringThe ARN of the Amazon OpenSearch Service domain.
indexRotationPeriod?stringThe Amazon OpenSearch Service index rotation period.
processingConfiguration?IResolvable | ProcessingConfigurationPropertyDescribes a data processing configuration.
retryOptions?IResolvable | AmazonopensearchserviceRetryOptionsPropertyThe retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
s3BackupMode?stringDefines how documents should be delivered to Amazon S3.
typeName?stringThe Amazon OpenSearch Service type name.
vpcConfiguration?IResolvable | VpcConfigurationPropertyThe details of the VPC of the Amazon OpenSearch Service destination.

indexName

Type: string

The Amazon OpenSearch Service index name.


roleArn

Type: string

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.


s3Configuration

Type: IResolvable | S3DestinationConfigurationProperty

Describes the configuration of a destination in Amazon S3.


bufferingHints?

Type: IResolvable | AmazonopensearchserviceBufferingHintsProperty (optional)

The buffering options.

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


cloudWatchLoggingOptions?

Type: IResolvable | CloudWatchLoggingOptionsProperty (optional)

Describes the Amazon CloudWatch logging options for your delivery stream.


clusterEndpoint?

Type: string (optional)

The endpoint to use when communicating with the cluster.

Specify either this ClusterEndpoint or the DomainARN field.


documentIdOptions?

Type: IResolvable | DocumentIdOptionsProperty (optional)

CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.DocumentIdOptions.


domainArn?

Type: string (optional)

The ARN of the Amazon OpenSearch Service domain.


indexRotationPeriod?

Type: string (optional)

The Amazon OpenSearch Service index rotation period.

Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.


processingConfiguration?

Type: IResolvable | ProcessingConfigurationProperty (optional)

Describes a data processing configuration.


retryOptions?

Type: IResolvable | AmazonopensearchserviceRetryOptionsProperty (optional)

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.

The default value is 300 (5 minutes).


s3BackupMode?

Type: string (optional)

Defines how documents should be delivered to Amazon S3.


typeName?

Type: string (optional)

The Amazon OpenSearch Service type name.


vpcConfiguration?

Type: IResolvable | VpcConfigurationProperty (optional)

The details of the VPC of the Amazon OpenSearch Service destination.