Class CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty

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

Inheritance

object

CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty

Implements

CfnDeliveryStreamPropsMixin.IElasticsearchDestinationConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.KinesisFirehose.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty : CfnDeliveryStreamPropsMixin.IElasticsearchDestinationConfigurationProperty

Syntax (vb)

Public Class CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty Implements CfnDeliveryStreamPropsMixin.IElasticsearchDestinationConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.KinesisFirehose.Mixins;

             var elasticsearchDestinationConfigurationProperty = new ElasticsearchDestinationConfigurationProperty {
                 BufferingHints = new ElasticsearchBufferingHintsProperty {
                     IntervalInSeconds = 123,
                     SizeInMBs = 123
                 },
                 CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                     Enabled = false,
                     LogGroupName = "logGroupName",
                     LogStreamName = "logStreamName"
                 },
                 ClusterEndpoint = "clusterEndpoint",
                 DocumentIdOptions = new DocumentIdOptionsProperty {
                     DefaultDocumentIdFormat = "defaultDocumentIdFormat"
                 },
                 DomainArn = "domainArn",
                 IndexName = "indexName",
                 IndexRotationPeriod = "indexRotationPeriod",
                 ProcessingConfiguration = new ProcessingConfigurationProperty {
                     Enabled = false,
                     Processors = new [] { new ProcessorProperty {
                         Parameters = new [] { new ProcessorParameterProperty {
                             ParameterName = "parameterName",
                             ParameterValue = "parameterValue"
                         } },
                         Type = "type"
                     } }
                 },
                 RetryOptions = new ElasticsearchRetryOptionsProperty {
                     DurationInSeconds = 123
                 },
                 RoleArn = "roleArn",
                 S3BackupMode = "s3BackupMode",
                 S3Configuration = new S3DestinationConfigurationProperty {
                     BucketArn = "bucketArn",
                     BufferingHints = new BufferingHintsProperty {
                         IntervalInSeconds = 123,
                         SizeInMBs = 123
                     },
                     CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                         Enabled = false,
                         LogGroupName = "logGroupName",
                         LogStreamName = "logStreamName"
                     },
                     CompressionFormat = "compressionFormat",
                     EncryptionConfiguration = new EncryptionConfigurationProperty {
                         KmsEncryptionConfig = new KMSEncryptionConfigProperty {
                             AwskmsKeyArn = "awskmsKeyArn"
                         },
                         NoEncryptionConfig = "noEncryptionConfig"
                     },
                     ErrorOutputPrefix = "errorOutputPrefix",
                     Prefix = "prefix",
                     RoleArn = "roleArn"
                 },
                 TypeName = "typeName",
                 VpcConfiguration = new VpcConfigurationProperty {
                     RoleArn = "roleArn",
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             };

Synopsis

Constructors

ElasticsearchDestinationConfigurationProperty()

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

Properties

BufferingHints	Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.
CloudWatchLoggingOptions	The Amazon CloudWatch Logs logging options for the delivery stream.
ClusterEndpoint	The endpoint to use when communicating with the cluster.
DocumentIdOptions	Indicates the method for setting up document ID.
DomainArn	The ARN of the Amazon ES domain.
IndexName	The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing.
IndexRotationPeriod	The frequency of Elasticsearch index rotation.
ProcessingConfiguration	The data processing configuration for the Kinesis Data Firehose delivery stream.
RetryOptions	The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.
RoleArn	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.
S3BackupMode	The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3).
S3Configuration	The S3 bucket where Kinesis Data Firehose backs up incoming data.
TypeName	The Elasticsearch type name that Amazon ES adds to documents when indexing data.
VpcConfiguration	The details of the VPC of the Amazon ES destination.

Constructors

ElasticsearchDestinationConfigurationProperty()

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

public ElasticsearchDestinationConfigurationProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.KinesisFirehose.Mixins;

             var elasticsearchDestinationConfigurationProperty = new ElasticsearchDestinationConfigurationProperty {
                 BufferingHints = new ElasticsearchBufferingHintsProperty {
                     IntervalInSeconds = 123,
                     SizeInMBs = 123
                 },
                 CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                     Enabled = false,
                     LogGroupName = "logGroupName",
                     LogStreamName = "logStreamName"
                 },
                 ClusterEndpoint = "clusterEndpoint",
                 DocumentIdOptions = new DocumentIdOptionsProperty {
                     DefaultDocumentIdFormat = "defaultDocumentIdFormat"
                 },
                 DomainArn = "domainArn",
                 IndexName = "indexName",
                 IndexRotationPeriod = "indexRotationPeriod",
                 ProcessingConfiguration = new ProcessingConfigurationProperty {
                     Enabled = false,
                     Processors = new [] { new ProcessorProperty {
                         Parameters = new [] { new ProcessorParameterProperty {
                             ParameterName = "parameterName",
                             ParameterValue = "parameterValue"
                         } },
                         Type = "type"
                     } }
                 },
                 RetryOptions = new ElasticsearchRetryOptionsProperty {
                     DurationInSeconds = 123
                 },
                 RoleArn = "roleArn",
                 S3BackupMode = "s3BackupMode",
                 S3Configuration = new S3DestinationConfigurationProperty {
                     BucketArn = "bucketArn",
                     BufferingHints = new BufferingHintsProperty {
                         IntervalInSeconds = 123,
                         SizeInMBs = 123
                     },
                     CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                         Enabled = false,
                         LogGroupName = "logGroupName",
                         LogStreamName = "logStreamName"
                     },
                     CompressionFormat = "compressionFormat",
                     EncryptionConfiguration = new EncryptionConfigurationProperty {
                         KmsEncryptionConfig = new KMSEncryptionConfigProperty {
                             AwskmsKeyArn = "awskmsKeyArn"
                         },
                         NoEncryptionConfig = "noEncryptionConfig"
                     },
                     ErrorOutputPrefix = "errorOutputPrefix",
                     Prefix = "prefix",
                     RoleArn = "roleArn"
                 },
                 TypeName = "typeName",
                 VpcConfiguration = new VpcConfigurationProperty {
                     RoleArn = "roleArn",
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             };

Properties

BufferingHints

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

public object? BufferingHints { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-bufferinghints

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IElasticsearchBufferingHintsProperty

CloudWatchLoggingOptions

The Amazon CloudWatch Logs logging options for the delivery stream.

public object? CloudWatchLoggingOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.ICloudWatchLoggingOptionsProperty

ClusterEndpoint

The endpoint to use when communicating with the cluster.

public string? ClusterEndpoint { get; set; }

Property Value

string

Remarks

Specify either this ClusterEndpoint or the DomainARN field.

DocumentIdOptions

Indicates the method for setting up document ID.

public object? DocumentIdOptions { get; set; }

Property Value

object

Remarks

The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IDocumentIdOptionsProperty

DomainArn

The ARN of the Amazon ES domain.

public string? DomainArn { get; set; }

Property Value

string

Remarks

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

Specify either ClusterEndpoint or DomainARN .

IndexName

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

public string? IndexName { get; set; }

Property Value

string

Remarks

IndexRotationPeriod

The frequency of Elasticsearch index rotation.

public string? IndexRotationPeriod { get; set; }

Property Value

string

Remarks

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

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

public object? ProcessingConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IProcessingConfigurationProperty

RetryOptions

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

public object? RetryOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IElasticsearchRetryOptionsProperty

RoleArn

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.

public string? RoleArn { get; set; }

Property Value

string

Remarks

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

S3BackupMode

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

public string? S3BackupMode { get; set; }

Property Value

string

Remarks

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 .

S3Configuration

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

public object? S3Configuration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IS3DestinationConfigurationProperty

TypeName

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

public string? TypeName { get; set; }

Property Value

string

Remarks

VpcConfiguration

The details of the VPC of the Amazon ES destination.

public object? VpcConfiguration { get; set; }