software.amazon.awssdk.services.firehose.model

Class ElasticsearchDestinationUpdate

java.lang.Object

software.amazon.awssdk.services.firehose.model.ElasticsearchDestinationUpdate

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ElasticsearchDestinationUpdate.Builder,ElasticsearchDestinationUpdate>

@Generated(value="software.amazon.awssdk:codegen")
public final class ElasticsearchDestinationUpdate
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ElasticsearchDestinationUpdate.Builder,ElasticsearchDestinationUpdate>

Describes an update for a destination in Amazon ES.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ElasticsearchDestinationUpdate.Builder

Method Summary

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	clusterEndpoint() The endpoint to use when communicating with the cluster.
String	domainARN() The ARN of the Amazon ES domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(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.
ProcessingConfiguration	processingConfiguration() The data processing configuration.
ElasticsearchRetryOptions	retryOptions() The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.
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.
S3DestinationUpdate	s3Update() The Amazon S3 destination.
List<SdkField<?>>	sdkFields()
static Class<? extends ElasticsearchDestinationUpdate.Builder>	serializableBuilderClass()
ElasticsearchDestinationUpdate.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	typeName() The Elasticsearch type name.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

roleARN

public final 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 AWS Service Namespaces.

Returns:

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 AWS Service Namespaces.

domainARN

public final 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. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

Returns:

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. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

clusterEndpoint

public final String clusterEndpoint()

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

Returns:

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

indexName

public final String indexName()

The Elasticsearch index name.

Returns:

The Elasticsearch index name.

typeName

public final 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 runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

Returns:

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 runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

indexRotationPeriod

public final ElasticsearchIndexRotationPeriod indexRotationPeriod()

The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES 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().

Returns:

The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.

See Also:

ElasticsearchIndexRotationPeriod

indexRotationPeriodAsString

public final String indexRotationPeriodAsString()

The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES 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().

Returns:

The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.

See Also:

ElasticsearchIndexRotationPeriod

bufferingHints

public final ElasticsearchBufferingHints bufferingHints()

The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.

Returns:

The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.

retryOptions

public final 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).

Returns:

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

s3Update

public final S3DestinationUpdate s3Update()

The Amazon S3 destination.

Returns:

The Amazon S3 destination.

processingConfiguration

public final ProcessingConfiguration processingConfiguration()

The data processing configuration.

Returns:

The data processing configuration.

cloudWatchLoggingOptions

public final CloudWatchLoggingOptions cloudWatchLoggingOptions()

The CloudWatch logging options for your delivery stream.

Returns:

The CloudWatch logging options for your delivery stream.

toBuilder

public ElasticsearchDestinationUpdate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ElasticsearchDestinationUpdate.Builder,ElasticsearchDestinationUpdate>

builder

public static ElasticsearchDestinationUpdate.Builder builder()

serializableBuilderClass

public static Class<? extends ElasticsearchDestinationUpdate.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo