public static interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.kinesisfirehose.*;
ElasticsearchDestinationConfigurationProperty elasticsearchDestinationConfigurationProperty = ElasticsearchDestinationConfigurationProperty.builder()
.indexName("indexName")
.roleArn("roleArn")
.s3Configuration(S3DestinationConfigurationProperty.builder()
.bucketArn("bucketArn")
.roleArn("roleArn")
// the properties below are optional
.bufferingHints(BufferingHintsProperty.builder()
.intervalInSeconds(123)
.sizeInMBs(123)
.build())
.cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
.enabled(false)
.logGroupName("logGroupName")
.logStreamName("logStreamName")
.build())
.compressionFormat("compressionFormat")
.encryptionConfiguration(EncryptionConfigurationProperty.builder()
.kmsEncryptionConfig(KMSEncryptionConfigProperty.builder()
.awskmsKeyArn("awskmsKeyArn")
.build())
.noEncryptionConfig("noEncryptionConfig")
.build())
.errorOutputPrefix("errorOutputPrefix")
.prefix("prefix")
.build())
// the properties below are optional
.bufferingHints(ElasticsearchBufferingHintsProperty.builder()
.intervalInSeconds(123)
.sizeInMBs(123)
.build())
.cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
.enabled(false)
.logGroupName("logGroupName")
.logStreamName("logStreamName")
.build())
.clusterEndpoint("clusterEndpoint")
.domainArn("domainArn")
.indexRotationPeriod("indexRotationPeriod")
.processingConfiguration(ProcessingConfigurationProperty.builder()
.enabled(false)
.processors(List.of(ProcessorProperty.builder()
.type("type")
// the properties below are optional
.parameters(List.of(ProcessorParameterProperty.builder()
.parameterName("parameterName")
.parameterValue("parameterValue")
.build()))
.build()))
.build())
.retryOptions(ElasticsearchRetryOptionsProperty.builder()
.durationInSeconds(123)
.build())
.s3BackupMode("s3BackupMode")
.typeName("typeName")
.vpcConfiguration(VpcConfigurationProperty.builder()
.roleArn("roleArn")
.securityGroupIds(List.of("securityGroupIds"))
.subnetIds(List.of("subnetIds"))
.build())
.build();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Builder
|
static class |
CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Jsii$Proxy
An implementation for
CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty |
| Modifier and Type | Method and Description |
|---|---|
static CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Builder |
builder() |
default java.lang.Object |
getBufferingHints()
Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.
|
default java.lang.Object |
getCloudWatchLoggingOptions()
The Amazon CloudWatch Logs logging options for the delivery stream.
|
default java.lang.String |
getClusterEndpoint()
The endpoint to use when communicating with the cluster.
|
default java.lang.String |
getDomainArn()
The ARN of the Amazon ES domain.
|
java.lang.String |
getIndexName()
The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing.
|
default java.lang.String |
getIndexRotationPeriod()
The frequency of Elasticsearch index rotation.
|
default java.lang.Object |
getProcessingConfiguration()
The data processing configuration for the Kinesis Data Firehose delivery stream.
|
default java.lang.Object |
getRetryOptions()
The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.
|
java.lang.String |
getRoleArn()
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.
|
default java.lang.String |
getS3BackupMode()
The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3).
|
java.lang.Object |
getS3Configuration()
The S3 bucket where Kinesis Data Firehose backs up incoming data.
|
default java.lang.String |
getTypeName()
The Elasticsearch type name that Amazon ES adds to documents when indexing data.
|
default java.lang.Object |
getVpcConfiguration()
The details of the VPC of the Amazon ES destination.
|
java.lang.String getIndexName()
java.lang.String getRoleArn()
For more information, see Controlling Access with Amazon Kinesis Data Firehose .
java.lang.Object getS3Configuration()
default java.lang.Object getBufferingHints()
default java.lang.Object getCloudWatchLoggingOptions()
default java.lang.String getClusterEndpoint()
Specify either this ClusterEndpoint or the DomainARN field.
default java.lang.String getDomainArn()
The IAM role must have permissions for DescribeElasticsearchDomain , DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN .
Specify either ClusterEndpoint or DomainARN .
default java.lang.String getIndexRotationPeriod()
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 .
default java.lang.Object getProcessingConfiguration()
default java.lang.Object getRetryOptions()
default java.lang.String getS3BackupMode()
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 .
default java.lang.String getTypeName()
default java.lang.Object getVpcConfiguration()