@Generated(value="software.amazon.awssdk:codegen") public class ElasticsearchDestinationConfiguration extends Object implements StructuredPojo, software.amazon.awssdk.utils.builder.ToCopyableBuilder<ElasticsearchDestinationConfiguration.Builder,ElasticsearchDestinationConfiguration>
Describes the configuration of a destination in Amazon ES.
Modifier and Type | Class and Description |
---|---|
static interface |
ElasticsearchDestinationConfiguration.Builder |
Modifier and Type | Method and Description |
---|---|
ElasticsearchBufferingHints |
bufferingHints()
The buffering options.
|
static ElasticsearchDestinationConfiguration.Builder |
builder() |
CloudWatchLoggingOptions |
cloudWatchLoggingOptions()
The CloudWatch logging options for your delivery stream.
|
String |
domainARN()
The ARN of the Amazon ES domain.
|
boolean |
equals(Object obj) |
int |
hashCode() |
String |
indexName()
The Elasticsearch index name.
|
String |
indexRotationPeriod()
The Elasticsearch index rotation period.
|
void |
marshall(ProtocolMarshaller protocolMarshaller) |
ProcessingConfiguration |
processingConfiguration()
The data processing configuration.
|
ElasticsearchRetryOptions |
retryOptions()
The retry behavior in the event that Firehose is unable to deliver documents to Amazon ES.
|
String |
roleARN()
The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing
documents.
|
String |
s3BackupMode()
Defines how documents should be delivered to Amazon S3.
|
S3DestinationConfiguration |
s3Configuration()
The configuration for the intermediate Amazon S3 location from which Amazon ES obtains data.
|
static Class<? extends ElasticsearchDestinationConfiguration.Builder> |
serializableBuilderClass() |
ElasticsearchDestinationConfiguration.Builder |
toBuilder() |
String |
toString() |
String |
typeName()
The Elasticsearch type name.
|
public 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.
public 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.
DescribeElasticsearchDomain
, DescribeElasticsearchDomains
, and
DescribeElasticsearchDomainConfig
after assuming the role specified in RoleARN.public String indexName()
The Elasticsearch index name.
public String typeName()
The Elasticsearch type name.
public 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
.
OneDay
.ElasticsearchIndexRotationPeriod
public ElasticsearchBufferingHints bufferingHints()
The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.
public 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).
public 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.
ElasticsearchS3BackupMode
public S3DestinationConfiguration s3Configuration()
The configuration for the intermediate Amazon S3 location from which Amazon ES obtains data.
public ProcessingConfiguration processingConfiguration()
The data processing configuration.
public CloudWatchLoggingOptions cloudWatchLoggingOptions()
The CloudWatch logging options for your delivery stream.
public ElasticsearchDestinationConfiguration.Builder toBuilder()
toBuilder
in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<ElasticsearchDestinationConfiguration.Builder,ElasticsearchDestinationConfiguration>
public static ElasticsearchDestinationConfiguration.Builder builder()
public static Class<? extends ElasticsearchDestinationConfiguration.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
marshall
in interface StructuredPojo
Copyright © 2017. All rights reserved.