public class ElasticsearchDestinationConfiguration extends Object implements Serializable, Cloneable
Describes the configuration of a destination in Amazon ES.
Constructor and Description |
---|
ElasticsearchDestinationConfiguration() |
Modifier and Type | Method and Description |
---|---|
ElasticsearchDestinationConfiguration |
clone() |
boolean |
equals(Object obj) |
ElasticsearchBufferingHints |
getBufferingHints()
Buffering options.
|
CloudWatchLoggingOptions |
getCloudWatchLoggingOptions()
Describes CloudWatch logging options for your delivery stream.
|
String |
getDomainARN()
The ARN of the Amazon ES domain.
|
String |
getIndexName()
The Elasticsearch index name.
|
String |
getIndexRotationPeriod()
The Elasticsearch index rotation period.
|
ElasticsearchRetryOptions |
getRetryOptions()
Configures retry behavior in the event that Firehose is unable to deliver
documents to Amazon ES.
|
String |
getRoleARN()
The ARN of the IAM role to be assumed by Firehose for calling the Amazon
ES Configuration API and for indexing documents.
|
String |
getS3BackupMode()
Defines how documents should be delivered to Amazon S3.
|
S3DestinationConfiguration |
getS3Configuration() |
String |
getTypeName()
The Elasticsearch type name.
|
int |
hashCode() |
void |
setBufferingHints(ElasticsearchBufferingHints bufferingHints)
Buffering options.
|
void |
setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
Describes CloudWatch logging options for your delivery stream.
|
void |
setDomainARN(String domainARN)
The ARN of the Amazon ES domain.
|
void |
setIndexName(String indexName)
The Elasticsearch index name.
|
void |
setIndexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)
The Elasticsearch index rotation period.
|
void |
setIndexRotationPeriod(String indexRotationPeriod)
The Elasticsearch index rotation period.
|
void |
setRetryOptions(ElasticsearchRetryOptions retryOptions)
Configures retry behavior in the event that Firehose is unable to deliver
documents to Amazon ES.
|
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.
|
void |
setS3BackupMode(ElasticsearchS3BackupMode s3BackupMode)
Defines how documents should be delivered to Amazon S3.
|
void |
setS3BackupMode(String s3BackupMode)
Defines how documents should be delivered to Amazon S3.
|
void |
setS3Configuration(S3DestinationConfiguration s3Configuration) |
void |
setTypeName(String typeName)
The Elasticsearch type name.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ElasticsearchDestinationConfiguration |
withBufferingHints(ElasticsearchBufferingHints bufferingHints)
Buffering options.
|
ElasticsearchDestinationConfiguration |
withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
Describes CloudWatch logging options for your delivery stream.
|
ElasticsearchDestinationConfiguration |
withDomainARN(String domainARN)
The ARN of the Amazon ES domain.
|
ElasticsearchDestinationConfiguration |
withIndexName(String indexName)
The Elasticsearch index name.
|
ElasticsearchDestinationConfiguration |
withIndexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)
The Elasticsearch index rotation period.
|
ElasticsearchDestinationConfiguration |
withIndexRotationPeriod(String indexRotationPeriod)
The Elasticsearch index rotation period.
|
ElasticsearchDestinationConfiguration |
withRetryOptions(ElasticsearchRetryOptions retryOptions)
Configures retry behavior in the event that Firehose is unable to deliver
documents to Amazon ES.
|
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.
|
ElasticsearchDestinationConfiguration |
withS3BackupMode(ElasticsearchS3BackupMode s3BackupMode)
Defines how documents should be delivered to Amazon S3.
|
ElasticsearchDestinationConfiguration |
withS3BackupMode(String s3BackupMode)
Defines how documents should be delivered to Amazon S3.
|
ElasticsearchDestinationConfiguration |
withS3Configuration(S3DestinationConfiguration s3Configuration) |
ElasticsearchDestinationConfiguration |
withTypeName(String typeName)
The Elasticsearch type name.
|
public ElasticsearchDestinationConfiguration()
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.
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.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.
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.
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.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.
domainARN
- The ARN of the Amazon ES domain. The IAM role must have permission
for DescribeElasticsearchDomain
,
DescribeElasticsearchDomains
, and
DescribeElasticsearchDomainConfig
after assuming
RoleARN.public String getDomainARN()
The ARN of the Amazon ES domain. The IAM role must have permission for
DescribeElasticsearchDomain
,
DescribeElasticsearchDomains
, and
DescribeElasticsearchDomainConfig
after assuming
RoleARN.
DescribeElasticsearchDomain
,
DescribeElasticsearchDomains
, and
DescribeElasticsearchDomainConfig
after assuming
RoleARN.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.
domainARN
- The ARN of the Amazon ES domain. The IAM role must have permission
for DescribeElasticsearchDomain
,
DescribeElasticsearchDomains
, and
DescribeElasticsearchDomainConfig
after assuming
RoleARN.public void setIndexName(String indexName)
The Elasticsearch index name.
indexName
- The Elasticsearch index name.public String getIndexName()
The Elasticsearch index name.
public ElasticsearchDestinationConfiguration withIndexName(String indexName)
The Elasticsearch index name.
indexName
- The Elasticsearch index name.public void setTypeName(String typeName)
The Elasticsearch type name.
typeName
- The Elasticsearch type name.public String getTypeName()
The Elasticsearch type name.
public ElasticsearchDestinationConfiguration withTypeName(String typeName)
The Elasticsearch type name.
typeName
- The Elasticsearch type name.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
.
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
.ElasticsearchIndexRotationPeriod
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
.
OneDay
.ElasticsearchIndexRotationPeriod
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
.
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
.ElasticsearchIndexRotationPeriod
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
.
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
.ElasticsearchIndexRotationPeriod
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
.
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
.ElasticsearchIndexRotationPeriod
public void setBufferingHints(ElasticsearchBufferingHints bufferingHints)
Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
bufferingHints
- Buffering options. If no value is specified,
ElasticsearchBufferingHints object default values are used.public ElasticsearchBufferingHints getBufferingHints()
Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
public ElasticsearchDestinationConfiguration withBufferingHints(ElasticsearchBufferingHints bufferingHints)
Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
bufferingHints
- Buffering options. If no value is specified,
ElasticsearchBufferingHints object default values are used.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).
retryOptions
- Configures retry behavior in the event that Firehose is unable to
deliver documents to Amazon ES. Default value is 300 (5 minutes).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).
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).
retryOptions
- Configures retry behavior in the event that Firehose is unable to
deliver documents to Amazon ES. Default value is 300 (5 minutes).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.
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.ElasticsearchS3BackupMode
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.
ElasticsearchS3BackupMode
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.
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.ElasticsearchS3BackupMode
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.
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.ElasticsearchS3BackupMode
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.
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.ElasticsearchS3BackupMode
public void setS3Configuration(S3DestinationConfiguration s3Configuration)
s3Configuration
- public S3DestinationConfiguration getS3Configuration()
public ElasticsearchDestinationConfiguration withS3Configuration(S3DestinationConfiguration s3Configuration)
s3Configuration
- public void setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
Describes CloudWatch logging options for your delivery stream.
cloudWatchLoggingOptions
- Describes CloudWatch logging options for your delivery stream.public CloudWatchLoggingOptions getCloudWatchLoggingOptions()
Describes CloudWatch logging options for your delivery stream.
public ElasticsearchDestinationConfiguration withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
Describes CloudWatch logging options for your delivery stream.
cloudWatchLoggingOptions
- Describes CloudWatch logging options for your delivery stream.public String toString()
toString
in class Object
Object.toString()
public ElasticsearchDestinationConfiguration clone()
Copyright © 2016. All rights reserved.