@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonopensearchserviceDestinationConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
Describes the configuration of a destination in Amazon OpenSearch Service
Constructor and Description |
---|
AmazonopensearchserviceDestinationConfiguration() |
Modifier and Type | Method and Description |
---|---|
AmazonopensearchserviceDestinationConfiguration |
clone() |
boolean |
equals(Object obj) |
AmazonopensearchserviceBufferingHints |
getBufferingHints()
The buffering options.
|
CloudWatchLoggingOptions |
getCloudWatchLoggingOptions() |
String |
getClusterEndpoint()
The endpoint to use when communicating with the cluster.
|
String |
getDomainARN()
The ARN of the Amazon OpenSearch Service domain.
|
String |
getIndexName()
The ElasticsearAmazon OpenSearch Service index name.
|
String |
getIndexRotationPeriod()
The Amazon OpenSearch Service index rotation period.
|
ProcessingConfiguration |
getProcessingConfiguration() |
AmazonopensearchserviceRetryOptions |
getRetryOptions()
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
|
String |
getRoleARN()
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon
OpenSearch Service Configuration API and for indexing documents.
|
String |
getS3BackupMode()
Defines how documents should be delivered to Amazon S3.
|
S3DestinationConfiguration |
getS3Configuration() |
String |
getTypeName()
The Amazon OpenSearch Service type name.
|
VpcConfiguration |
getVpcConfiguration() |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setBufferingHints(AmazonopensearchserviceBufferingHints bufferingHints)
The buffering options.
|
void |
setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) |
void |
setClusterEndpoint(String clusterEndpoint)
The endpoint to use when communicating with the cluster.
|
void |
setDomainARN(String domainARN)
The ARN of the Amazon OpenSearch Service domain.
|
void |
setIndexName(String indexName)
The ElasticsearAmazon OpenSearch Service index name.
|
void |
setIndexRotationPeriod(String indexRotationPeriod)
The Amazon OpenSearch Service index rotation period.
|
void |
setProcessingConfiguration(ProcessingConfiguration processingConfiguration) |
void |
setRetryOptions(AmazonopensearchserviceRetryOptions retryOptions)
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
|
void |
setRoleARN(String roleARN)
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon
OpenSearch Service Configuration API and for indexing documents.
|
void |
setS3BackupMode(String s3BackupMode)
Defines how documents should be delivered to Amazon S3.
|
void |
setS3Configuration(S3DestinationConfiguration s3Configuration) |
void |
setTypeName(String typeName)
The Amazon OpenSearch Service type name.
|
void |
setVpcConfiguration(VpcConfiguration vpcConfiguration) |
String |
toString()
Returns a string representation of this object.
|
AmazonopensearchserviceDestinationConfiguration |
withBufferingHints(AmazonopensearchserviceBufferingHints bufferingHints)
The buffering options.
|
AmazonopensearchserviceDestinationConfiguration |
withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) |
AmazonopensearchserviceDestinationConfiguration |
withClusterEndpoint(String clusterEndpoint)
The endpoint to use when communicating with the cluster.
|
AmazonopensearchserviceDestinationConfiguration |
withDomainARN(String domainARN)
The ARN of the Amazon OpenSearch Service domain.
|
AmazonopensearchserviceDestinationConfiguration |
withIndexName(String indexName)
The ElasticsearAmazon OpenSearch Service index name.
|
AmazonopensearchserviceDestinationConfiguration |
withIndexRotationPeriod(AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod)
The Amazon OpenSearch Service index rotation period.
|
AmazonopensearchserviceDestinationConfiguration |
withIndexRotationPeriod(String indexRotationPeriod)
The Amazon OpenSearch Service index rotation period.
|
AmazonopensearchserviceDestinationConfiguration |
withProcessingConfiguration(ProcessingConfiguration processingConfiguration) |
AmazonopensearchserviceDestinationConfiguration |
withRetryOptions(AmazonopensearchserviceRetryOptions retryOptions)
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
|
AmazonopensearchserviceDestinationConfiguration |
withRoleARN(String roleARN)
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon
OpenSearch Service Configuration API and for indexing documents.
|
AmazonopensearchserviceDestinationConfiguration |
withS3BackupMode(AmazonopensearchserviceS3BackupMode s3BackupMode)
Defines how documents should be delivered to Amazon S3.
|
AmazonopensearchserviceDestinationConfiguration |
withS3BackupMode(String s3BackupMode)
Defines how documents should be delivered to Amazon S3.
|
AmazonopensearchserviceDestinationConfiguration |
withS3Configuration(S3DestinationConfiguration s3Configuration) |
AmazonopensearchserviceDestinationConfiguration |
withTypeName(String typeName)
The Amazon OpenSearch Service type name.
|
AmazonopensearchserviceDestinationConfiguration |
withVpcConfiguration(VpcConfiguration vpcConfiguration) |
public AmazonopensearchserviceDestinationConfiguration()
public void setRoleARN(String roleARN)
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
roleARN
- The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the
Amazon OpenSearch Service Configuration API and for indexing documents.public String getRoleARN()
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
public AmazonopensearchserviceDestinationConfiguration withRoleARN(String roleARN)
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
roleARN
- The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the
Amazon OpenSearch Service Configuration API and for indexing documents.public void setDomainARN(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.
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.public String getDomainARN()
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.
public AmazonopensearchserviceDestinationConfiguration withDomainARN(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.
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.public void setClusterEndpoint(String clusterEndpoint)
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
clusterEndpoint
- The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the
DomainARN field.public String getClusterEndpoint()
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
public AmazonopensearchserviceDestinationConfiguration withClusterEndpoint(String clusterEndpoint)
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
clusterEndpoint
- The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the
DomainARN field.public void setIndexName(String indexName)
The ElasticsearAmazon OpenSearch Service index name.
indexName
- The ElasticsearAmazon OpenSearch Service index name.public String getIndexName()
The ElasticsearAmazon OpenSearch Service index name.
public AmazonopensearchserviceDestinationConfiguration withIndexName(String indexName)
The ElasticsearAmazon OpenSearch Service index name.
indexName
- The ElasticsearAmazon OpenSearch Service index name.public void setTypeName(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, Kinesis Data Firehose returns an error during run time.
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, Kinesis Data Firehose
returns an error during run time.public String getTypeName()
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, Kinesis Data Firehose returns an error during run time.
public AmazonopensearchserviceDestinationConfiguration withTypeName(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, Kinesis Data Firehose returns an error during run time.
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, Kinesis Data Firehose
returns an error during run time.public void setIndexRotationPeriod(String indexRotationPeriod)
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
indexRotationPeriod
- The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName
to facilitate the expiration of old data.AmazonopensearchserviceIndexRotationPeriod
public String getIndexRotationPeriod()
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
AmazonopensearchserviceIndexRotationPeriod
public AmazonopensearchserviceDestinationConfiguration withIndexRotationPeriod(String indexRotationPeriod)
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
indexRotationPeriod
- The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName
to facilitate the expiration of old data.AmazonopensearchserviceIndexRotationPeriod
public AmazonopensearchserviceDestinationConfiguration withIndexRotationPeriod(AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod)
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
indexRotationPeriod
- The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName
to facilitate the expiration of old data.AmazonopensearchserviceIndexRotationPeriod
public void setBufferingHints(AmazonopensearchserviceBufferingHints bufferingHints)
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
bufferingHints
- The buffering options. If no value is specified, the default values for
AmazonopensearchserviceBufferingHints are used.public AmazonopensearchserviceBufferingHints getBufferingHints()
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
public AmazonopensearchserviceDestinationConfiguration withBufferingHints(AmazonopensearchserviceBufferingHints bufferingHints)
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
bufferingHints
- The buffering options. If no value is specified, the default values for
AmazonopensearchserviceBufferingHints are used.public void setRetryOptions(AmazonopensearchserviceRetryOptions retryOptions)
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
retryOptions
- The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch
Service. The default value is 300 (5 minutes).public AmazonopensearchserviceRetryOptions getRetryOptions()
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
public AmazonopensearchserviceDestinationConfiguration withRetryOptions(AmazonopensearchserviceRetryOptions retryOptions)
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
retryOptions
- The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch
Service. The default value is 300 (5 minutes).public void setS3BackupMode(String s3BackupMode)
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data 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, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
s3BackupMode
- Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis
Data 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, Kinesis Data
Firehose delivers all incoming records to Amazon S3, and also writes failed documents with
AmazonOpenSearchService-failed/ appended to the prefix.AmazonopensearchserviceS3BackupMode
public String getS3BackupMode()
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data 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, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
AmazonopensearchserviceS3BackupMode
public AmazonopensearchserviceDestinationConfiguration withS3BackupMode(String s3BackupMode)
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data 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, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
s3BackupMode
- Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis
Data 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, Kinesis Data
Firehose delivers all incoming records to Amazon S3, and also writes failed documents with
AmazonOpenSearchService-failed/ appended to the prefix.AmazonopensearchserviceS3BackupMode
public AmazonopensearchserviceDestinationConfiguration withS3BackupMode(AmazonopensearchserviceS3BackupMode s3BackupMode)
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data 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, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
s3BackupMode
- Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis
Data 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, Kinesis Data
Firehose delivers all incoming records to Amazon S3, and also writes failed documents with
AmazonOpenSearchService-failed/ appended to the prefix.AmazonopensearchserviceS3BackupMode
public void setS3Configuration(S3DestinationConfiguration s3Configuration)
s3Configuration
- public S3DestinationConfiguration getS3Configuration()
public AmazonopensearchserviceDestinationConfiguration withS3Configuration(S3DestinationConfiguration s3Configuration)
s3Configuration
- public void setProcessingConfiguration(ProcessingConfiguration processingConfiguration)
processingConfiguration
- public ProcessingConfiguration getProcessingConfiguration()
public AmazonopensearchserviceDestinationConfiguration withProcessingConfiguration(ProcessingConfiguration processingConfiguration)
processingConfiguration
- public void setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
cloudWatchLoggingOptions
- public CloudWatchLoggingOptions getCloudWatchLoggingOptions()
public AmazonopensearchserviceDestinationConfiguration withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
cloudWatchLoggingOptions
- public void setVpcConfiguration(VpcConfiguration vpcConfiguration)
vpcConfiguration
- public VpcConfiguration getVpcConfiguration()
public AmazonopensearchserviceDestinationConfiguration withVpcConfiguration(VpcConfiguration vpcConfiguration)
vpcConfiguration
- public String toString()
toString
in class Object
Object.toString()
public AmazonopensearchserviceDestinationConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.