@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ElasticsearchDestinationConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
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()
The buffering options.
|
CloudWatchLoggingOptions |
getCloudWatchLoggingOptions()
The 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.
|
ProcessingConfiguration |
getProcessingConfiguration()
The data processing configuration.
|
ElasticsearchRetryOptions |
getRetryOptions()
The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES.
|
String |
getRoleARN()
The ARN of the IAM role to be assumed by Kinesis 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()
The configuration for the backup Amazon S3 location.
|
String |
getTypeName()
The Elasticsearch type name.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setBufferingHints(ElasticsearchBufferingHints bufferingHints)
The buffering options.
|
void |
setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
The 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 |
setProcessingConfiguration(ProcessingConfiguration processingConfiguration)
The data processing configuration.
|
void |
setRetryOptions(ElasticsearchRetryOptions retryOptions)
The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES.
|
void |
setRoleARN(String roleARN)
The ARN of the IAM role to be assumed by Kinesis 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)
The configuration for the backup Amazon S3 location.
|
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)
The buffering options.
|
ElasticsearchDestinationConfiguration |
withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
The 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 |
withProcessingConfiguration(ProcessingConfiguration processingConfiguration)
The data processing configuration.
|
ElasticsearchDestinationConfiguration |
withRetryOptions(ElasticsearchRetryOptions retryOptions)
The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES.
|
ElasticsearchDestinationConfiguration |
withRoleARN(String roleARN)
The ARN of the IAM role to be assumed by Kinesis 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)
The configuration for the backup Amazon S3 location.
|
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 Kinesis 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 Kinesis 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 Kinesis 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 Kinesis 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 Kinesis 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 permissions for DescribeElasticsearchDomain
,
DescribeElasticsearchDomains
, and DescribeElasticsearchDomainConfig
after assuming the
role specified in RoleARN.
domainARN
- The ARN of the Amazon ES domain. The IAM role must have permissions for
DescribeElasticsearchDomain
, DescribeElasticsearchDomains
, and
DescribeElasticsearchDomainConfig
after assuming the role specified in RoleARN.public String getDomainARN()
The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain
,
DescribeElasticsearchDomains
, and DescribeElasticsearchDomainConfig
after assuming the
role specified in RoleARN.
DescribeElasticsearchDomain
, DescribeElasticsearchDomains
, and
DescribeElasticsearchDomainConfig
after assuming the role specified in RoleARN.public ElasticsearchDestinationConfiguration withDomainARN(String domainARN)
The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain
,
DescribeElasticsearchDomains
, and DescribeElasticsearchDomainConfig
after assuming the
role specified in RoleARN.
domainARN
- The ARN of the Amazon ES domain. The IAM role must have permissions for
DescribeElasticsearchDomain
, DescribeElasticsearchDomains
, and
DescribeElasticsearchDomainConfig
after assuming the role specified in 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 time stamp to the IndexName to facilitate the
expiration of old data. For more information, see Index Rotation for
Amazon Elasticsearch Service Destination. The default value is OneDay
.
indexRotationPeriod
- The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to
facilitate the expiration of old data. For more information, see Index Rotation
for Amazon Elasticsearch Service Destination. The default value is OneDay
.ElasticsearchIndexRotationPeriod
public String getIndexRotationPeriod()
The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to facilitate the
expiration of old data. For more information, see Index Rotation for
Amazon Elasticsearch Service Destination. The default value is OneDay
.
OneDay
.ElasticsearchIndexRotationPeriod
public ElasticsearchDestinationConfiguration withIndexRotationPeriod(String indexRotationPeriod)
The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to facilitate the
expiration of old data. For more information, see Index Rotation for
Amazon Elasticsearch Service Destination. The default value is OneDay
.
indexRotationPeriod
- The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to
facilitate the expiration of old data. For more information, see Index Rotation
for Amazon Elasticsearch Service Destination. The default value is OneDay
.ElasticsearchIndexRotationPeriod
public void setIndexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)
The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to facilitate the
expiration of old data. For more information, see Index Rotation for
Amazon Elasticsearch Service Destination. The default value is OneDay
.
indexRotationPeriod
- The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to
facilitate the expiration of old data. For more information, see Index Rotation
for Amazon Elasticsearch Service Destination. The default value is OneDay
.ElasticsearchIndexRotationPeriod
public ElasticsearchDestinationConfiguration withIndexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)
The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to facilitate the
expiration of old data. For more information, see Index Rotation for
Amazon Elasticsearch Service Destination. The default value is OneDay
.
indexRotationPeriod
- The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to
facilitate the expiration of old data. For more information, see Index Rotation
for Amazon Elasticsearch Service Destination. The default value is OneDay
.ElasticsearchIndexRotationPeriod
public void setBufferingHints(ElasticsearchBufferingHints bufferingHints)
The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.
bufferingHints
- The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints
are used.public ElasticsearchBufferingHints getBufferingHints()
The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.
public ElasticsearchDestinationConfiguration withBufferingHints(ElasticsearchBufferingHints bufferingHints)
The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.
bufferingHints
- The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints
are used.public void setRetryOptions(ElasticsearchRetryOptions retryOptions)
The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
retryOptions
- The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES. The default value
is 300 (5 minutes).public ElasticsearchRetryOptions getRetryOptions()
The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
public ElasticsearchDestinationConfiguration withRetryOptions(ElasticsearchRetryOptions retryOptions)
The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
retryOptions
- The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES. The default value
is 300 (5 minutes).public void setS3BackupMode(String s3BackupMode)
Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis 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, Kinesis 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, Kinesis 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, Kinesis 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, Kinesis 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, Kinesis 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, Kinesis 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, Kinesis 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, Kinesis 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, Kinesis 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, Kinesis 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, Kinesis 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, Kinesis 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, Kinesis 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, Kinesis 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, Kinesis 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, Kinesis 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, Kinesis 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)
The configuration for the backup Amazon S3 location.
s3Configuration
- The configuration for the backup Amazon S3 location.public S3DestinationConfiguration getS3Configuration()
The configuration for the backup Amazon S3 location.
public ElasticsearchDestinationConfiguration withS3Configuration(S3DestinationConfiguration s3Configuration)
The configuration for the backup Amazon S3 location.
s3Configuration
- The configuration for the backup Amazon S3 location.public void setProcessingConfiguration(ProcessingConfiguration processingConfiguration)
The data processing configuration.
processingConfiguration
- The data processing configuration.public ProcessingConfiguration getProcessingConfiguration()
The data processing configuration.
public ElasticsearchDestinationConfiguration withProcessingConfiguration(ProcessingConfiguration processingConfiguration)
The data processing configuration.
processingConfiguration
- The data processing configuration.public void setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
The CloudWatch logging options for your delivery stream.
cloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.public CloudWatchLoggingOptions getCloudWatchLoggingOptions()
The CloudWatch logging options for your delivery stream.
public ElasticsearchDestinationConfiguration withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
The CloudWatch logging options for your delivery stream.
cloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.public String toString()
toString
in class Object
Object.toString()
public ElasticsearchDestinationConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.