public static interface AmazonopensearchserviceDestinationConfiguration.Builder extends SdkPojo, CopyableBuilder<AmazonopensearchserviceDestinationConfiguration.Builder,AmazonopensearchserviceDestinationConfiguration>
equalsBySdkFields, sdkFieldscopyapplyMutation, buildAmazonopensearchserviceDestinationConfiguration.Builder roleARN(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.AmazonopensearchserviceDestinationConfiguration.Builder domainARN(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.AmazonopensearchserviceDestinationConfiguration.Builder clusterEndpoint(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.AmazonopensearchserviceDestinationConfiguration.Builder indexName(String indexName)
The ElasticsearAmazon OpenSearch Service index name.
indexName - The ElasticsearAmazon OpenSearch Service index name.AmazonopensearchserviceDestinationConfiguration.Builder typeName(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.AmazonopensearchserviceDestinationConfiguration.Builder indexRotationPeriod(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,
AmazonopensearchserviceIndexRotationPeriodAmazonopensearchserviceDestinationConfiguration.Builder indexRotationPeriod(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,
AmazonopensearchserviceIndexRotationPeriodAmazonopensearchserviceDestinationConfiguration.Builder bufferingHints(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.default AmazonopensearchserviceDestinationConfiguration.Builder bufferingHints(Consumer<AmazonopensearchserviceBufferingHints.Builder> bufferingHints)
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
This is a convenience method that creates an instance of theAmazonopensearchserviceBufferingHints.Builder avoiding the need to create one manually via
AmazonopensearchserviceBufferingHints.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to bufferingHints(AmazonopensearchserviceBufferingHints).
bufferingHints - a consumer that will call methods on AmazonopensearchserviceBufferingHints.BuilderbufferingHints(AmazonopensearchserviceBufferingHints)AmazonopensearchserviceDestinationConfiguration.Builder retryOptions(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).default AmazonopensearchserviceDestinationConfiguration.Builder retryOptions(Consumer<AmazonopensearchserviceRetryOptions.Builder> 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).
This is a convenience method that creates an instance of theAmazonopensearchserviceRetryOptions.Builder avoiding the need to create one manually via
AmazonopensearchserviceRetryOptions.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to retryOptions(AmazonopensearchserviceRetryOptions).
retryOptions - a consumer that will call methods on AmazonopensearchserviceRetryOptions.BuilderretryOptions(AmazonopensearchserviceRetryOptions)AmazonopensearchserviceDestinationConfiguration.Builder s3BackupMode(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,
AmazonopensearchserviceS3BackupModeAmazonopensearchserviceDestinationConfiguration.Builder s3BackupMode(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,
AmazonopensearchserviceS3BackupModeAmazonopensearchserviceDestinationConfiguration.Builder s3Configuration(S3DestinationConfiguration s3Configuration)
s3Configuration - The new value for the S3Configuration property for this object.default AmazonopensearchserviceDestinationConfiguration.Builder s3Configuration(Consumer<S3DestinationConfiguration.Builder> s3Configuration)
S3DestinationConfiguration.Builder
avoiding the need to create one manually via S3DestinationConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to s3Configuration(S3DestinationConfiguration).
s3Configuration - a consumer that will call methods on S3DestinationConfiguration.Builders3Configuration(S3DestinationConfiguration)AmazonopensearchserviceDestinationConfiguration.Builder processingConfiguration(ProcessingConfiguration processingConfiguration)
processingConfiguration - The new value for the ProcessingConfiguration property for this object.default AmazonopensearchserviceDestinationConfiguration.Builder processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)
ProcessingConfiguration.Builder avoiding
the need to create one manually via ProcessingConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to processingConfiguration(ProcessingConfiguration).
processingConfiguration - a consumer that will call methods on ProcessingConfiguration.BuilderprocessingConfiguration(ProcessingConfiguration)AmazonopensearchserviceDestinationConfiguration.Builder cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
cloudWatchLoggingOptions - The new value for the CloudWatchLoggingOptions property for this object.default AmazonopensearchserviceDestinationConfiguration.Builder cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)
CloudWatchLoggingOptions.Builder
avoiding the need to create one manually via CloudWatchLoggingOptions.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to cloudWatchLoggingOptions(CloudWatchLoggingOptions).
cloudWatchLoggingOptions - a consumer that will call methods on CloudWatchLoggingOptions.BuildercloudWatchLoggingOptions(CloudWatchLoggingOptions)AmazonopensearchserviceDestinationConfiguration.Builder vpcConfiguration(VpcConfiguration vpcConfiguration)
vpcConfiguration - The new value for the VpcConfiguration property for this object.default AmazonopensearchserviceDestinationConfiguration.Builder vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration)
VpcConfiguration.Builder avoiding the
need to create one manually via VpcConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to vpcConfiguration(VpcConfiguration).
vpcConfiguration - a consumer that will call methods on VpcConfiguration.BuildervpcConfiguration(VpcConfiguration)AmazonopensearchserviceDestinationConfiguration.Builder documentIdOptions(DocumentIdOptions documentIdOptions)
Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
documentIdOptions - Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose
generated document ID and OpenSearch Service generated document ID.default AmazonopensearchserviceDestinationConfiguration.Builder documentIdOptions(Consumer<DocumentIdOptions.Builder> documentIdOptions)
Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
This is a convenience method that creates an instance of theDocumentIdOptions.Builder avoiding the
need to create one manually via DocumentIdOptions.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to documentIdOptions(DocumentIdOptions).
documentIdOptions - a consumer that will call methods on DocumentIdOptions.BuilderdocumentIdOptions(DocumentIdOptions)Copyright © 2023. All rights reserved.