aws-cdk-lib.aws_kinesisfirehose.CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty

interface AmazonOpenSearchServerlessDestinationConfigurationProperty

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

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

NameTypeDescription
indexNamestringCfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.IndexName.
roleArnstringCfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.RoleARN.
s3ConfigurationIResolvable | S3DestinationConfigurationPropertyCfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.S3Configuration.
bufferingHints?IResolvable | AmazonOpenSearchServerlessBufferingHintsPropertyCfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.BufferingHints.
cloudWatchLoggingOptions?IResolvable | CloudWatchLoggingOptionsPropertyCfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.CloudWatchLoggingOptions.
collectionEndpoint?stringCfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.CollectionEndpoint.
processingConfiguration?IResolvable | ProcessingConfigurationPropertyCfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.ProcessingConfiguration.
retryOptions?IResolvable | AmazonOpenSearchServerlessRetryOptionsPropertyCfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.RetryOptions.
s3BackupMode?stringCfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.S3BackupMode.
vpcConfiguration?IResolvable | VpcConfigurationPropertyCfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.VpcConfiguration.

indexName

Type: string

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.IndexName.


roleArn

Type: string

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.RoleARN.


s3Configuration

Type: IResolvable | S3DestinationConfigurationProperty

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.S3Configuration.


bufferingHints?

Type: IResolvable | AmazonOpenSearchServerlessBufferingHintsProperty (optional)

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.BufferingHints.


cloudWatchLoggingOptions?

Type: IResolvable | CloudWatchLoggingOptionsProperty (optional)

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.CloudWatchLoggingOptions.


collectionEndpoint?

Type: string (optional)

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.CollectionEndpoint.


processingConfiguration?

Type: IResolvable | ProcessingConfigurationProperty (optional)

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.ProcessingConfiguration.


retryOptions?

Type: IResolvable | AmazonOpenSearchServerlessRetryOptionsProperty (optional)

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.RetryOptions.


s3BackupMode?

Type: string (optional)

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.S3BackupMode.


vpcConfiguration?

Type: IResolvable | VpcConfigurationProperty (optional)

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.VpcConfiguration.