public static interface ElasticsearchDestinationConfiguration.Builder extends software.amazon.awssdk.utils.builder.CopyableBuilder<ElasticsearchDestinationConfiguration.Builder,ElasticsearchDestinationConfiguration>
copy
apply, build
ElasticsearchDestinationConfiguration.Builder roleARN(String roleARN)
The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access.
roleARN
- The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for
indexing documents. For more information, see Amazon S3
Bucket Access.ElasticsearchDestinationConfiguration.Builder domainARN(String domainARN)
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.
domainARN
- 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.ElasticsearchDestinationConfiguration.Builder indexName(String indexName)
The Elasticsearch index name.
indexName
- The Elasticsearch index name.ElasticsearchDestinationConfiguration.Builder typeName(String typeName)
The Elasticsearch type name.
typeName
- The Elasticsearch type name.ElasticsearchDestinationConfiguration.Builder indexRotationPeriod(String indexRotationPeriod)
The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate
expiration of old data. For more information, see Index Rotation for
Amazon Elasticsearch Service Destination. The default value is OneDay
.
indexRotationPeriod
- The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to
facilitate expiration of old data. For more information, see Index
Rotation for Amazon Elasticsearch Service Destination. The default value is OneDay
.ElasticsearchIndexRotationPeriod
ElasticsearchDestinationConfiguration.Builder indexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)
The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate
expiration of old data. For more information, see Index Rotation for
Amazon Elasticsearch Service Destination. The default value is OneDay
.
indexRotationPeriod
- The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to
facilitate expiration of old data. For more information, see Index
Rotation for Amazon Elasticsearch Service Destination. The default value is OneDay
.ElasticsearchIndexRotationPeriod
ElasticsearchDestinationConfiguration.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.ElasticsearchDestinationConfiguration.Builder retryOptions(ElasticsearchRetryOptions retryOptions)
The retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
retryOptions
- The retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. The default
value is 300 (5 minutes).ElasticsearchDestinationConfiguration.Builder s3BackupMode(String s3BackupMode)
Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.
s3BackupMode
- Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose
writes any documents that could not be indexed to the configured Amazon S3 destination, with
elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all
incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to
the prefix. For more information, see Amazon S3 Backup
for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.ElasticsearchS3BackupMode
ElasticsearchDestinationConfiguration.Builder s3BackupMode(ElasticsearchS3BackupMode s3BackupMode)
Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.
s3BackupMode
- Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose
writes any documents that could not be indexed to the configured Amazon S3 destination, with
elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all
incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to
the prefix. For more information, see Amazon S3 Backup
for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.ElasticsearchS3BackupMode
ElasticsearchDestinationConfiguration.Builder s3Configuration(S3DestinationConfiguration s3Configuration)
The configuration for the intermediate Amazon S3 location from which Amazon ES obtains data.
s3Configuration
- The configuration for the intermediate Amazon S3 location from which Amazon ES obtains data.ElasticsearchDestinationConfiguration.Builder processingConfiguration(ProcessingConfiguration processingConfiguration)
The data processing configuration.
processingConfiguration
- The data processing configuration.ElasticsearchDestinationConfiguration.Builder cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
The CloudWatch logging options for your delivery stream.
cloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.Copyright © 2017. All rights reserved.