Class AmazonopensearchserviceDestinationConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AmazonopensearchserviceDestinationConfiguration.Builder,
AmazonopensearchserviceDestinationConfiguration>
Describes the configuration of a destination in Amazon OpenSearch Service
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionThe buffering options.builder()
final CloudWatchLoggingOptions
Returns the value of the CloudWatchLoggingOptions property for this object.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 OpenSearch Service 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 ElasticsearAmazon OpenSearch Service index name.The Amazon OpenSearch Service index rotation period.final String
The Amazon OpenSearch Service index rotation period.final ProcessingConfiguration
Returns the value of the ProcessingConfiguration property for this object.The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.final String
roleARN()
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service 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.Returns the value of the S3Configuration property for this object.static Class
<? extends AmazonopensearchserviceDestinationConfiguration.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 Amazon OpenSearch Service type name.final VpcConfiguration
Returns the value of the VpcConfiguration property for this object.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 OpenSearch Service Configuration API and for indexing documents.
- Returns:
- The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
-
domainARN
The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.
- Returns:
- The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.
-
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
The ElasticsearAmazon OpenSearch Service index name.
- Returns:
- The ElasticsearAmazon OpenSearch Service index name.
-
typeName
The Amazon OpenSearch Service 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.
- Returns:
- The Amazon OpenSearch Service 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.
-
indexRotationPeriod
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
If the service returns an enum value that is not available in the current SDK version,
indexRotationPeriod
will returnAmazonopensearchserviceIndexRotationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromindexRotationPeriodAsString()
.- Returns:
- The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
- See Also:
-
indexRotationPeriodAsString
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
If the service returns an enum value that is not available in the current SDK version,
indexRotationPeriod
will returnAmazonopensearchserviceIndexRotationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromindexRotationPeriodAsString()
.- Returns:
- The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
- See Also:
-
bufferingHints
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
- Returns:
- The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
-
retryOptions
The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
- Returns:
- The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. 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, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
If the service returns an enum value that is not available in the current SDK version,
s3BackupMode
will returnAmazonopensearchserviceS3BackupMode.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, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
- 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, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
If the service returns an enum value that is not available in the current SDK version,
s3BackupMode
will returnAmazonopensearchserviceS3BackupMode.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, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
- See Also:
-
s3Configuration
Returns the value of the S3Configuration property for this object.- Returns:
- The value of the S3Configuration property for this object.
-
processingConfiguration
Returns the value of the ProcessingConfiguration property for this object.- Returns:
- The value of the ProcessingConfiguration property for this object.
-
cloudWatchLoggingOptions
Returns the value of the CloudWatchLoggingOptions property for this object.- Returns:
- The value of the CloudWatchLoggingOptions property for this object.
-
vpcConfiguration
Returns the value of the VpcConfiguration property for this object.- Returns:
- The value of the VpcConfiguration property for this object.
-
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<AmazonopensearchserviceDestinationConfiguration.Builder,
AmazonopensearchserviceDestinationConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends AmazonopensearchserviceDestinationConfiguration.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
-