Class ElasticsearchDestinationConfiguration

java.lang.Object
com.amazonaws.services.kinesisfirehose.model.ElasticsearchDestinationConfiguration
All Implemented Interfaces:
Serializable, Cloneable

public class ElasticsearchDestinationConfiguration extends Object implements Serializable, Cloneable

Describes the configuration of a destination in Amazon ES.

See Also:
  • Constructor Details

    • ElasticsearchDestinationConfiguration

      public ElasticsearchDestinationConfiguration()
  • Method Details

    • setRoleARN

      public void setRoleARN(String roleARN)

      The 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 Amazon S3 Bucket Access.

      Parameters:
      roleARN - The 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 Amazon S3 Bucket Access.
    • getRoleARN

      public String getRoleARN()

      The 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 Amazon S3 Bucket Access.

      Returns:
      The 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 Amazon S3 Bucket Access.
    • withRoleARN

      public ElasticsearchDestinationConfiguration withRoleARN(String roleARN)

      The 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 Amazon S3 Bucket Access.

      Parameters:
      roleARN - The 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 Amazon S3 Bucket Access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDomainARN

      public void setDomainARN(String domainARN)

      The ARN of the Amazon ES domain. The IAM role must have permission for  DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN.

      Parameters:
      domainARN - The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN.
    • getDomainARN

      public String getDomainARN()

      The ARN of the Amazon ES domain. The IAM role must have permission for  DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN.

      Returns:
      The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN.
    • withDomainARN

      public ElasticsearchDestinationConfiguration withDomainARN(String domainARN)

      The ARN of the Amazon ES domain. The IAM role must have permission for  DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN.

      Parameters:
      domainARN - The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setIndexName

      public void setIndexName(String indexName)

      The Elasticsearch index name.

      Parameters:
      indexName - The Elasticsearch index name.
    • getIndexName

      public String getIndexName()

      The Elasticsearch index name.

      Returns:
      The Elasticsearch index name.
    • withIndexName

      public ElasticsearchDestinationConfiguration withIndexName(String indexName)

      The Elasticsearch index name.

      Parameters:
      indexName - The Elasticsearch index name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setTypeName

      public void setTypeName(String typeName)

      The Elasticsearch type name.

      Parameters:
      typeName - The Elasticsearch type name.
    • getTypeName

      public String getTypeName()

      The Elasticsearch type name.

      Returns:
      The Elasticsearch type name.
    • withTypeName

      public ElasticsearchDestinationConfiguration withTypeName(String typeName)

      The Elasticsearch type name.

      Parameters:
      typeName - The Elasticsearch type name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setIndexRotationPeriod

      public void setIndexRotationPeriod(String indexRotationPeriod)

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

      Parameters:
      indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is OneDay.
      See Also:
    • getIndexRotationPeriod

      public String getIndexRotationPeriod()

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

      Returns:
      The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is OneDay.
      See Also:
    • withIndexRotationPeriod

      public ElasticsearchDestinationConfiguration withIndexRotationPeriod(String indexRotationPeriod)

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

      Parameters:
      indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is OneDay.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setIndexRotationPeriod

      public void setIndexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)

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

      Parameters:
      indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is OneDay.
      See Also:
    • withIndexRotationPeriod

      public ElasticsearchDestinationConfiguration withIndexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)

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

      Parameters:
      indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is OneDay.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setBufferingHints

      public void setBufferingHints(ElasticsearchBufferingHints bufferingHints)

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

      Parameters:
      bufferingHints - Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
    • getBufferingHints

      public ElasticsearchBufferingHints getBufferingHints()

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

      Returns:
      Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
    • withBufferingHints

      public ElasticsearchDestinationConfiguration withBufferingHints(ElasticsearchBufferingHints bufferingHints)

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

      Parameters:
      bufferingHints - Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setRetryOptions

      public void setRetryOptions(ElasticsearchRetryOptions retryOptions)

      Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).

      Parameters:
      retryOptions - Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).
    • getRetryOptions

      public ElasticsearchRetryOptions getRetryOptions()

      Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).

      Returns:
      Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).
    • withRetryOptions

      public ElasticsearchDestinationConfiguration withRetryOptions(ElasticsearchRetryOptions retryOptions)

      Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).

      Parameters:
      retryOptions - Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setS3BackupMode

      public void setS3BackupMode(String s3BackupMode)

      Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.

      Parameters:
      s3BackupMode - Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.
      See Also:
    • getS3BackupMode

      public String getS3BackupMode()

      Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.

      Returns:
      Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.
      See Also:
    • withS3BackupMode

      public ElasticsearchDestinationConfiguration withS3BackupMode(String s3BackupMode)

      Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.

      Parameters:
      s3BackupMode - Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setS3BackupMode

      public void setS3BackupMode(ElasticsearchS3BackupMode s3BackupMode)

      Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.

      Parameters:
      s3BackupMode - Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.
      See Also:
    • withS3BackupMode

      public ElasticsearchDestinationConfiguration withS3BackupMode(ElasticsearchS3BackupMode s3BackupMode)

      Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.

      Parameters:
      s3BackupMode - Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setS3Configuration

      public void setS3Configuration(S3DestinationConfiguration s3Configuration)
      Parameters:
      s3Configuration -
    • getS3Configuration

      public S3DestinationConfiguration getS3Configuration()
      Returns:
    • withS3Configuration

      public ElasticsearchDestinationConfiguration withS3Configuration(S3DestinationConfiguration s3Configuration)
      Parameters:
      s3Configuration -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setCloudWatchLoggingOptions

      public void setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)

      Describes CloudWatch logging options for your delivery stream.

      Parameters:
      cloudWatchLoggingOptions - Describes CloudWatch logging options for your delivery stream.
    • getCloudWatchLoggingOptions

      public CloudWatchLoggingOptions getCloudWatchLoggingOptions()

      Describes CloudWatch logging options for your delivery stream.

      Returns:
      Describes CloudWatch logging options for your delivery stream.
    • withCloudWatchLoggingOptions

      public ElasticsearchDestinationConfiguration withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)

      Describes CloudWatch logging options for your delivery stream.

      Parameters:
      cloudWatchLoggingOptions - Describes CloudWatch logging options for your delivery stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      Overrides:
      clone in class Object