@Generated(value="software.amazon.awssdk:codegen") public final class ElasticsearchDestinationUpdate extends Object implements StructuredPojo, ToCopyableBuilder<ElasticsearchDestinationUpdate.Builder,ElasticsearchDestinationUpdate>
Describes an update for a destination in Amazon ES.
Modifier and Type | Class and Description |
---|---|
static interface |
ElasticsearchDestinationUpdate.Builder |
Modifier and Type | Method and Description |
---|---|
ElasticsearchBufferingHints |
bufferingHints()
The buffering options.
|
static ElasticsearchDestinationUpdate.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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
indexName()
The Elasticsearch index name.
|
ElasticsearchIndexRotationPeriod |
indexRotationPeriod()
The Elasticsearch index rotation period.
|
String |
indexRotationPeriodAsString()
The Elasticsearch index rotation period.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
ProcessingConfiguration |
processingConfiguration()
The data processing configuration.
|
ElasticsearchRetryOptions |
retryOptions()
The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES.
|
String |
roleARN()
The ARN of the IAM role to be assumed by Kinesis Firehose for calling the Amazon ES Configuration API and for
indexing documents.
|
S3DestinationUpdate |
s3Update()
The Amazon S3 destination.
|
static Class<? extends ElasticsearchDestinationUpdate.Builder> |
serializableBuilderClass() |
ElasticsearchDestinationUpdate.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
typeName()
The Elasticsearch type name.
|
copy
public String roleARN()
The ARN of the IAM role to be assumed by Kinesis 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
IAM role specified in RoleARN.
DescribeElasticsearchDomain
, DescribeElasticsearchDomains
, and
DescribeElasticsearchDomainConfig
after assuming the IAM role specified in RoleARN.public String indexName()
The Elasticsearch index name.
public String typeName()
The Elasticsearch type name.
public ElasticsearchIndexRotationPeriod indexRotationPeriod()
The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the
expiration of old data. For more information, see Index Rotation for
Amazon Elasticsearch Service Destination. Default value is OneDay
.
If the service returns an enum value that is not available in the current SDK version,
indexRotationPeriod
will return ElasticsearchIndexRotationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from indexRotationPeriodAsString()
.
OneDay
.ElasticsearchIndexRotationPeriod
public String indexRotationPeriodAsString()
The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the
expiration of old data. For more information, see Index Rotation for
Amazon Elasticsearch Service Destination. Default value is OneDay
.
If the service returns an enum value that is not available in the current SDK version,
indexRotationPeriod
will return ElasticsearchIndexRotationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from indexRotationPeriodAsString()
.
OneDay
.ElasticsearchIndexRotationPeriod
public ElasticsearchBufferingHints bufferingHints()
The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
public ElasticsearchRetryOptions retryOptions()
The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
public S3DestinationUpdate s3Update()
The Amazon S3 destination.
public ProcessingConfiguration processingConfiguration()
The data processing configuration.
public CloudWatchLoggingOptions cloudWatchLoggingOptions()
The CloudWatch logging options for your delivery stream.
public ElasticsearchDestinationUpdate.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ElasticsearchDestinationUpdate.Builder,ElasticsearchDestinationUpdate>
public static ElasticsearchDestinationUpdate.Builder builder()
public static Class<? extends ElasticsearchDestinationUpdate.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.