public static interface ElasticsearchDestinationConfiguration.Builder extends SdkPojo, CopyableBuilder<ElasticsearchDestinationConfiguration.Builder,ElasticsearchDestinationConfiguration>
equalsBySdkFields, sdkFieldscopyapplyMutation, buildElasticsearchDestinationConfiguration.Builder roleARN(String 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. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
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. For more information, see Grant
Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource
Names (ARNs) and Amazon Web Services Service Namespaces.ElasticsearchDestinationConfiguration.Builder domainARN(String domainARN)
The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain,
DescribeDomains, and DescribeDomainConfig after assuming the role specified in
RoleARN. For more information, see Amazon Resource Names
(ARNs) and Amazon Web Services Service Namespaces.
Specify either ClusterEndpoint or DomainARN.
domainARN - The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain,
DescribeDomains, and DescribeDomainConfig after assuming the role specified
in RoleARN. For more information, see Amazon Resource
Names (ARNs) and Amazon Web Services Service Namespaces.
Specify either ClusterEndpoint or DomainARN.
ElasticsearchDestinationConfiguration.Builder clusterEndpoint(String clusterEndpoint)
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or
the DomainARN field.
clusterEndpoint - The endpoint to use when communicating with the cluster. Specify either this
ClusterEndpoint or the DomainARN field.ElasticsearchDestinationConfiguration.Builder indexName(String indexName)
The Elasticsearch index name.
indexName - The Elasticsearch index name.ElasticsearchDestinationConfiguration.Builder typeName(String typeName)
The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.
For Elasticsearch 7.x, don't specify a TypeName.
typeName - The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try
to specify a new type for an existing index that already has another type, Kinesis Data Firehose
returns an error during run time.
For Elasticsearch 7.x, don't specify a TypeName.
ElasticsearchDestinationConfiguration.Builder indexRotationPeriod(String indexRotationPeriod)
The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to
facilitate the expiration of old data. For more information, see Index Rotation
for the Amazon ES Destination. The default value is OneDay.
indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to the
IndexName to facilitate the expiration of old data. For more information, see Index
Rotation for the Amazon ES Destination. The default value is OneDay.ElasticsearchIndexRotationPeriod,
ElasticsearchIndexRotationPeriodElasticsearchDestinationConfiguration.Builder indexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)
The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to
facilitate the expiration of old data. For more information, see Index Rotation
for the Amazon ES Destination. The default value is OneDay.
indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to the
IndexName to facilitate the expiration of old data. For more information, see Index
Rotation for the Amazon ES Destination. The default value is OneDay.ElasticsearchIndexRotationPeriod,
ElasticsearchIndexRotationPeriodElasticsearchDestinationConfiguration.Builder bufferingHints(ElasticsearchBufferingHints bufferingHints)
The buffering options. If no value is specified, the default values for
ElasticsearchBufferingHints are used.
bufferingHints - The buffering options. If no value is specified, the default values for
ElasticsearchBufferingHints are used.default ElasticsearchDestinationConfiguration.Builder bufferingHints(Consumer<ElasticsearchBufferingHints.Builder> bufferingHints)
The buffering options. If no value is specified, the default values for
ElasticsearchBufferingHints are used.
ElasticsearchBufferingHints.Builder
avoiding the need to create one manually via ElasticsearchBufferingHints.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to bufferingHints(ElasticsearchBufferingHints).
bufferingHints - a consumer that will call methods on ElasticsearchBufferingHints.BuilderbufferingHints(ElasticsearchBufferingHints)ElasticsearchDestinationConfiguration.Builder retryOptions(ElasticsearchRetryOptions retryOptions)
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The
default value is 300 (5 minutes).default ElasticsearchDestinationConfiguration.Builder retryOptions(Consumer<ElasticsearchRetryOptions.Builder> retryOptions)
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
This is a convenience method that creates an instance of theElasticsearchRetryOptions.Builder
avoiding the need to create one manually via ElasticsearchRetryOptions.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to retryOptions(ElasticsearchRetryOptions).
retryOptions - a consumer that will call methods on ElasticsearchRetryOptions.BuilderretryOptions(ElasticsearchRetryOptions)ElasticsearchDestinationConfiguration.Builder s3BackupMode(String s3BackupMode)
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly,
Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination,
with AmazonOpenSearchService-failed/ appended to the key prefix. When set to
AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes
failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more
information, see Amazon S3 Backup for
the Amazon ES Destination. Default value is FailedDocumentsOnly.
You can't change this backup mode after you create the delivery stream.
s3BackupMode - Defines how documents should be delivered to Amazon S3. When it is set to
FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed
to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to
the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming
records to Amazon S3, and also writes failed documents with
AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3
Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.
You can't change this backup mode after you create the delivery stream.
ElasticsearchS3BackupMode,
ElasticsearchS3BackupModeElasticsearchDestinationConfiguration.Builder s3BackupMode(ElasticsearchS3BackupMode s3BackupMode)
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly,
Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination,
with AmazonOpenSearchService-failed/ appended to the key prefix. When set to
AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes
failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more
information, see Amazon S3 Backup for
the Amazon ES Destination. Default value is FailedDocumentsOnly.
You can't change this backup mode after you create the delivery stream.
s3BackupMode - Defines how documents should be delivered to Amazon S3. When it is set to
FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed
to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to
the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming
records to Amazon S3, and also writes failed documents with
AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3
Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.
You can't change this backup mode after you create the delivery stream.
ElasticsearchS3BackupMode,
ElasticsearchS3BackupModeElasticsearchDestinationConfiguration.Builder s3Configuration(S3DestinationConfiguration s3Configuration)
The configuration for the backup Amazon S3 location.
s3Configuration - The configuration for the backup Amazon S3 location.default ElasticsearchDestinationConfiguration.Builder s3Configuration(Consumer<S3DestinationConfiguration.Builder> s3Configuration)
The configuration for the backup Amazon S3 location.
This is a convenience method that creates an instance of theS3DestinationConfiguration.Builder
avoiding the need to create one manually via S3DestinationConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to s3Configuration(S3DestinationConfiguration).
s3Configuration - a consumer that will call methods on S3DestinationConfiguration.Builders3Configuration(S3DestinationConfiguration)ElasticsearchDestinationConfiguration.Builder processingConfiguration(ProcessingConfiguration processingConfiguration)
The data processing configuration.
processingConfiguration - The data processing configuration.default ElasticsearchDestinationConfiguration.Builder processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)
The data processing configuration.
This is a convenience method that creates an instance of theProcessingConfiguration.Builder avoiding
the need to create one manually via ProcessingConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to processingConfiguration(ProcessingConfiguration).
processingConfiguration - a consumer that will call methods on ProcessingConfiguration.BuilderprocessingConfiguration(ProcessingConfiguration)ElasticsearchDestinationConfiguration.Builder cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
The Amazon CloudWatch logging options for your delivery stream.
cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.default ElasticsearchDestinationConfiguration.Builder cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)
The Amazon CloudWatch logging options for your delivery stream.
This is a convenience method that creates an instance of theCloudWatchLoggingOptions.Builder
avoiding the need to create one manually via CloudWatchLoggingOptions.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to cloudWatchLoggingOptions(CloudWatchLoggingOptions).
cloudWatchLoggingOptions - a consumer that will call methods on CloudWatchLoggingOptions.BuildercloudWatchLoggingOptions(CloudWatchLoggingOptions)ElasticsearchDestinationConfiguration.Builder vpcConfiguration(VpcConfiguration vpcConfiguration)
The details of the VPC of the Amazon ES destination.
vpcConfiguration - The details of the VPC of the Amazon ES destination.default ElasticsearchDestinationConfiguration.Builder vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration)
The details of the VPC of the Amazon ES destination.
This is a convenience method that creates an instance of theVpcConfiguration.Builder avoiding the
need to create one manually via VpcConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to vpcConfiguration(VpcConfiguration).
vpcConfiguration - a consumer that will call methods on VpcConfiguration.BuildervpcConfiguration(VpcConfiguration)Copyright © 2023. All rights reserved.