Class 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.
Inheritance
Namespace: Amazon.CDK.AWS.KinesisFirehose
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ElasticsearchDestinationConfigurationProperty : Object, CfnDeliveryStream.IElasticsearchDestinationConfigurationProperty
Syntax (vb)
Public Class ElasticsearchDestinationConfigurationProperty
Inherits Object
Implements CfnDeliveryStream.IElasticsearchDestinationConfigurationProperty
Remarks
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.AWS.KinesisFirehose;
var elasticsearchDestinationConfigurationProperty = new ElasticsearchDestinationConfigurationProperty {
IndexName = "indexName",
RoleArn = "roleArn",
S3Configuration = new S3DestinationConfigurationProperty {
BucketArn = "bucketArn",
RoleArn = "roleArn",
// the properties below are optional
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"
},
// the properties below are optional
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",
IndexRotationPeriod = "indexRotationPeriod",
ProcessingConfiguration = new ProcessingConfigurationProperty {
Enabled = false,
Processors = new [] { new ProcessorProperty {
Type = "type",
// the properties below are optional
Parameters = new [] { new ProcessorParameterProperty {
ParameterName = "parameterName",
ParameterValue = "parameterValue"
} }
} }
},
RetryOptions = new ElasticsearchRetryOptionsProperty {
DurationInSeconds = 123
},
S3BackupMode = "s3BackupMode",
TypeName = "typeName",
VpcConfiguration = new VpcConfigurationProperty {
RoleArn = "roleArn",
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
};
Synopsis
Constructors
ElasticsearchDestinationConfigurationProperty() |
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()
public ElasticsearchDestinationConfigurationProperty()
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
System.Object
Remarks
CloudWatchLoggingOptions
The Amazon CloudWatch Logs logging options for the delivery stream.
public object CloudWatchLoggingOptions { get; set; }
Property Value
System.Object
Remarks
ClusterEndpoint
The endpoint to use when communicating with the cluster.
public string ClusterEndpoint { get; set; }
Property Value
System.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
System.Object
Remarks
The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
DomainArn
The ARN of the Amazon ES domain.
public string DomainArn { get; set; }
Property Value
System.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
System.String
Remarks
IndexRotationPeriod
The frequency of Elasticsearch index rotation.
public string IndexRotationPeriod { get; set; }
Property Value
System.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
System.Object
Remarks
RetryOptions
The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.
public object RetryOptions { get; set; }
Property Value
System.Object
Remarks
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
System.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
System.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
System.Object
Remarks
TypeName
The Elasticsearch type name that Amazon ES adds to documents when indexing data.
public string TypeName { get; set; }
Property Value
System.String
Remarks
VpcConfiguration
The details of the VPC of the Amazon ES destination.
public object VpcConfiguration { get; set; }
Property Value
System.Object