Package software.amazon.awssdk.services.firehose.model

Class AmazonopensearchserviceDestinationConfiguration

java.lang.Object
software.amazon.awssdk.services.firehose.model.AmazonopensearchserviceDestinationConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AmazonopensearchserviceDestinationConfiguration.Builder,AmazonopensearchserviceDestinationConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class AmazonopensearchserviceDestinationConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AmazonopensearchserviceDestinationConfiguration.Builder,AmazonopensearchserviceDestinationConfiguration>

Describes the configuration of a destination in Amazon OpenSearch Service

See Also:

  • Method Details

    • roleARN

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

      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

      public final String 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

      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 ElasticsearAmazon OpenSearch Service index name.

      Returns:
      The ElasticsearAmazon OpenSearch Service index name.

    • typeName

      public final String 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

      public final AmazonopensearchserviceIndexRotationPeriod 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 return AmazonopensearchserviceIndexRotationPeriod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexRotationPeriodAsString().

      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

      public final String 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 return AmazonopensearchserviceIndexRotationPeriod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexRotationPeriodAsString().

      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

      public final AmazonopensearchserviceBufferingHints 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

      public final AmazonopensearchserviceRetryOptions 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

      public final AmazonopensearchserviceS3BackupMode 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 return AmazonopensearchserviceS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().

      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

      public final String 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 return AmazonopensearchserviceS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().

      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

      public final S3DestinationConfiguration s3Configuration()
      Returns the value of the S3Configuration property for this object.
      Returns:
      The value of the S3Configuration property for this object.

    • processingConfiguration

      public final ProcessingConfiguration processingConfiguration()
      Returns the value of the ProcessingConfiguration property for this object.
      Returns:
      The value of the ProcessingConfiguration property for this object.

    • cloudWatchLoggingOptions

      public final CloudWatchLoggingOptions cloudWatchLoggingOptions()
      Returns the value of the CloudWatchLoggingOptions property for this object.
      Returns:
      The value of the CloudWatchLoggingOptions property for this object.

    • vpcConfiguration

      public final VpcConfiguration vpcConfiguration()
      Returns the value of the VpcConfiguration property for this object.
      Returns:
      The value of the VpcConfiguration property for this object.

    • documentIdOptions

      public final DocumentIdOptions 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

      public AmazonopensearchserviceDestinationConfiguration.Builder 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 interface ToCopyableBuilder<AmazonopensearchserviceDestinationConfiguration.Builder,AmazonopensearchserviceDestinationConfiguration>
      Returns:
      a builder for type T

    • builder

      public static AmazonopensearchserviceDestinationConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AmazonopensearchserviceDestinationConfiguration.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.