aws-cdk-lib.aws_kinesisfirehose.CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

interface ElasticsearchDestinationConfigurationProperty

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

The ElasticsearchDestinationConfiguration property type specifies an Amazon Elasticsearch Service (Amazon ES) domain that Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data to.

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 elasticsearchDestinationConfigurationProperty: kinesisfirehose.CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty = {
  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 name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing.
roleArnstringThe Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents.
s3ConfigurationIResolvable | S3DestinationConfigurationPropertyThe S3 bucket where Kinesis Data Firehose backs up incoming data.
bufferingHints?IResolvable | ElasticsearchBufferingHintsPropertyConfigures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.
cloudWatchLoggingOptions?IResolvable | CloudWatchLoggingOptionsPropertyThe Amazon CloudWatch Logs logging options for the delivery stream.
clusterEndpoint?stringThe endpoint to use when communicating with the cluster.
documentIdOptions?IResolvable | DocumentIdOptionsPropertyCfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.DocumentIdOptions.
domainArn?stringThe ARN of the Amazon ES domain.
indexRotationPeriod?stringThe frequency of Elasticsearch index rotation.
processingConfiguration?IResolvable | ProcessingConfigurationPropertyThe data processing configuration for the Kinesis Data Firehose delivery stream.
retryOptions?IResolvable | ElasticsearchRetryOptionsPropertyThe retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.
s3BackupMode?stringThe condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3).
typeName?stringThe Elasticsearch type name that Amazon ES adds to documents when indexing data.
vpcConfiguration?IResolvable | VpcConfigurationPropertyThe details of the VPC of the Amazon ES destination.

indexName

Type: string

The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing.


roleArn

Type: string

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

For more information, see Controlling Access with Amazon Kinesis Data Firehose .


s3Configuration

Type: IResolvable | S3DestinationConfigurationProperty

The S3 bucket where Kinesis Data Firehose backs up incoming data.


bufferingHints?

Type: IResolvable | ElasticsearchBufferingHintsProperty (optional)

Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.


cloudWatchLoggingOptions?

Type: IResolvable | CloudWatchLoggingOptionsProperty (optional)

The Amazon CloudWatch Logs logging options for the 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.ElasticsearchDestinationConfigurationProperty.DocumentIdOptions.


domainArn?

Type: string (optional)

The ARN of the Amazon ES domain.

The IAM role must have permissions for DescribeElasticsearchDomain , DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN .

Specify either ClusterEndpoint or DomainARN .


indexRotationPeriod?

Type: string (optional)

The frequency of Elasticsearch index rotation.

If you enable index rotation, Kinesis Data Firehose appends a portion of the UTC arrival timestamp to the specified index name, and rotates the appended timestamp accordingly. For more information, see Index Rotation for the Amazon ES Destination in the Amazon Kinesis Data Firehose Developer Guide .


processingConfiguration?

Type: IResolvable | ProcessingConfigurationProperty (optional)

The data processing configuration for the Kinesis Data Firehose delivery stream.


retryOptions?

Type: IResolvable | ElasticsearchRetryOptionsProperty (optional)

The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.


s3BackupMode?

Type: string (optional)

The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3).

You can send Amazon S3 all documents (all data) or only the documents that Kinesis Data Firehose could not deliver to the Amazon ES destination. For more information and valid values, see the S3BackupMode content for the ElasticsearchDestinationConfiguration data type in the Amazon Kinesis Data Firehose API Reference .


typeName?

Type: string (optional)

The Elasticsearch type name that Amazon ES adds to documents when indexing data.


vpcConfiguration?

Type: IResolvable | VpcConfigurationProperty (optional)

The details of the VPC of the Amazon ES destination.