Class ElasticsearchDestinationConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ElasticsearchDestinationConfiguration.Builder,
ElasticsearchDestinationConfiguration>
Describes the configuration of a destination in Amazon ES.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe buffering options.builder()
final CloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.final String
The endpoint to use when communicating with the cluster.final DocumentIdOptions
Indicates the method for setting up document ID.final String
The ARN of the Amazon ES domain.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The Elasticsearch index name.The Elasticsearch index rotation period.final String
The Elasticsearch index rotation period.final ProcessingConfiguration
The data processing configuration.The retry behavior in case Firehose is unable to deliver documents to Amazon ES.final String
roleARN()
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents.Defines how documents should be delivered to Amazon S3.final String
Defines how documents should be delivered to Amazon S3.The configuration for the backup Amazon S3 location.static Class
<? extends ElasticsearchDestinationConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
typeName()
The Elasticsearch type name.final VpcConfiguration
The details of the VPC of the Amazon destination.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
roleARN
The Amazon Resource Name (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 Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
- Returns:
- The Amazon Resource Name (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 Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
-
domainARN
The ARN of the Amazon ES domain. The IAM role must have permissions for
DescribeDomain
,DescribeDomains
, andDescribeDomainConfig
after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.Specify either
ClusterEndpoint
orDomainARN
.- Returns:
- The ARN of the Amazon ES domain. The IAM role must have permissions for
DescribeDomain
,DescribeDomains
, andDescribeDomainConfig
after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.Specify either
ClusterEndpoint
orDomainARN
.
-
clusterEndpoint
The endpoint to use when communicating with the cluster. Specify either this
ClusterEndpoint
or theDomainARN
field.- Returns:
- The endpoint to use when communicating with the cluster. Specify either this
ClusterEndpoint
or theDomainARN
field.
-
indexName
The Elasticsearch index name.
- Returns:
- The Elasticsearch index name.
-
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, Firehose returns an error during run time.
For Elasticsearch 7.x, don't specify a
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, Firehose returns an error during
run time.
For Elasticsearch 7.x, don't specify a
TypeName
.
-
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 isOneDay
.If the service returns an enum value that is not available in the current SDK version,
indexRotationPeriod
will returnElasticsearchIndexRotationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromindexRotationPeriodAsString()
.- Returns:
- 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 isOneDay
. - See Also:
-
indexRotationPeriodAsString
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 isOneDay
.If the service returns an enum value that is not available in the current SDK version,
indexRotationPeriod
will returnElasticsearchIndexRotationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromindexRotationPeriodAsString()
.- Returns:
- 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 isOneDay
. - See Also:
-
bufferingHints
The buffering options. If no value is specified, the default values for
ElasticsearchBufferingHints
are used.- Returns:
- The buffering options. If no value is specified, the default values for
ElasticsearchBufferingHints
are used.
-
retryOptions
The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
- Returns:
- The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
-
s3BackupMode
Defines how documents should be delivered to Amazon S3. When it is set to
FailedDocumentsOnly
, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, withAmazonOpenSearchService-failed/
appended to the key prefix. When set toAllDocuments
, Firehose delivers all incoming records to Amazon S3, and also writes failed documents withAmazonOpenSearchService-failed/
appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value isFailedDocumentsOnly
.You can't change this backup mode after you create the delivery stream.
If the service returns an enum value that is not available in the current SDK version,
s3BackupMode
will returnElasticsearchS3BackupMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3BackupModeAsString()
.- Returns:
- Defines how documents should be delivered to Amazon S3. When it is set to
FailedDocumentsOnly
, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, withAmazonOpenSearchService-failed/
appended to the key prefix. When set toAllDocuments
, Firehose delivers all incoming records to Amazon S3, and also writes failed documents withAmazonOpenSearchService-failed/
appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value isFailedDocumentsOnly
.You can't change this backup mode after you create the delivery stream.
- See Also:
-
s3BackupModeAsString
Defines how documents should be delivered to Amazon S3. When it is set to
FailedDocumentsOnly
, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, withAmazonOpenSearchService-failed/
appended to the key prefix. When set toAllDocuments
, Firehose delivers all incoming records to Amazon S3, and also writes failed documents withAmazonOpenSearchService-failed/
appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value isFailedDocumentsOnly
.You can't change this backup mode after you create the delivery stream.
If the service returns an enum value that is not available in the current SDK version,
s3BackupMode
will returnElasticsearchS3BackupMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3BackupModeAsString()
.- Returns:
- Defines how documents should be delivered to Amazon S3. When it is set to
FailedDocumentsOnly
, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, withAmazonOpenSearchService-failed/
appended to the key prefix. When set toAllDocuments
, Firehose delivers all incoming records to Amazon S3, and also writes failed documents withAmazonOpenSearchService-failed/
appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value isFailedDocumentsOnly
.You can't change this backup mode after you create the delivery stream.
- See Also:
-
s3Configuration
The configuration for the backup Amazon S3 location.
- Returns:
- The configuration for the backup Amazon S3 location.
-
processingConfiguration
The data processing configuration.
- Returns:
- The data processing configuration.
-
cloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.
- Returns:
- The Amazon CloudWatch logging options for your delivery stream.
-
vpcConfiguration
The details of the VPC of the Amazon destination.
- Returns:
- The details of the VPC of the Amazon destination.
-
documentIdOptions
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
- Returns:
- Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ElasticsearchDestinationConfiguration.Builder,
ElasticsearchDestinationConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends ElasticsearchDestinationConfiguration.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-