Interface AmazonopensearchserviceDestinationUpdate.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AmazonopensearchserviceDestinationUpdate.Builder,
,AmazonopensearchserviceDestinationUpdate> SdkBuilder<AmazonopensearchserviceDestinationUpdate.Builder,
,AmazonopensearchserviceDestinationUpdate> SdkPojo
- Enclosing class:
AmazonopensearchserviceDestinationUpdate
-
Method Summary
Modifier and TypeMethodDescriptionbufferingHints
(Consumer<AmazonopensearchserviceBufferingHints.Builder> bufferingHints) The buffering options.bufferingHints
(AmazonopensearchserviceBufferingHints bufferingHints) The buffering options.cloudWatchLoggingOptions
(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions) Sets the value of the CloudWatchLoggingOptions property for this object.cloudWatchLoggingOptions
(CloudWatchLoggingOptions cloudWatchLoggingOptions) Sets the value of the CloudWatchLoggingOptions property for this object.clusterEndpoint
(String clusterEndpoint) The endpoint to use when communicating with the cluster.documentIdOptions
(Consumer<DocumentIdOptions.Builder> documentIdOptions) Indicates the method for setting up document ID.documentIdOptions
(DocumentIdOptions documentIdOptions) Indicates the method for setting up document ID.The ARN of the Amazon OpenSearch Service domain.The Amazon OpenSearch Service index name.indexRotationPeriod
(String indexRotationPeriod) The Amazon OpenSearch Service index rotation period.indexRotationPeriod
(AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod) The Amazon OpenSearch Service index rotation period.processingConfiguration
(Consumer<ProcessingConfiguration.Builder> processingConfiguration) Sets the value of the ProcessingConfiguration property for this object.processingConfiguration
(ProcessingConfiguration processingConfiguration) Sets the value of the ProcessingConfiguration property for this object.retryOptions
(Consumer<AmazonopensearchserviceRetryOptions.Builder> retryOptions) The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.retryOptions
(AmazonopensearchserviceRetryOptions retryOptions) The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.s3Update
(Consumer<S3DestinationUpdate.Builder> s3Update) Sets the value of the S3Update property for this object.s3Update
(S3DestinationUpdate s3Update) Sets the value of the S3Update property for this object.The Amazon OpenSearch Service type name.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
roleARN
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
- Parameters:
roleARN
- The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainARN
The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.
- Parameters:
domainARN
- The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clusterEndpoint
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
- Parameters:
clusterEndpoint
- The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
indexName
The Amazon OpenSearch Service index name.
- Parameters:
indexName
- The Amazon OpenSearch Service index name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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, Firehose returns an error during runtime.
If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
- Parameters:
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, Firehose returns an error during runtime.If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
indexRotationPeriod
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
- Parameters:
indexRotationPeriod
- The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
indexRotationPeriod
AmazonopensearchserviceDestinationUpdate.Builder indexRotationPeriod(AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod) The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
- Parameters:
indexRotationPeriod
- The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
bufferingHints
AmazonopensearchserviceDestinationUpdate.Builder bufferingHints(AmazonopensearchserviceBufferingHints bufferingHints) The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
- Parameters:
bufferingHints
- The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bufferingHints
default AmazonopensearchserviceDestinationUpdate.Builder bufferingHints(Consumer<AmazonopensearchserviceBufferingHints.Builder> bufferingHints) The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
This is a convenience method that creates an instance of theAmazonopensearchserviceBufferingHints.Builder
avoiding the need to create one manually viaAmazonopensearchserviceBufferingHints.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobufferingHints(AmazonopensearchserviceBufferingHints)
.- Parameters:
bufferingHints
- a consumer that will call methods onAmazonopensearchserviceBufferingHints.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
retryOptions
AmazonopensearchserviceDestinationUpdate.Builder retryOptions(AmazonopensearchserviceRetryOptions retryOptions) The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
- Parameters:
retryOptions
- The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retryOptions
default AmazonopensearchserviceDestinationUpdate.Builder retryOptions(Consumer<AmazonopensearchserviceRetryOptions.Builder> retryOptions) The retry behavior in case 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 viaAmazonopensearchserviceRetryOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toretryOptions(AmazonopensearchserviceRetryOptions)
.- Parameters:
retryOptions
- a consumer that will call methods onAmazonopensearchserviceRetryOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
s3Update
Sets the value of the S3Update property for this object.- Parameters:
s3Update
- The new value for the S3Update property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3Update
default AmazonopensearchserviceDestinationUpdate.Builder s3Update(Consumer<S3DestinationUpdate.Builder> s3Update) Sets the value of the S3Update property for this object. This is a convenience method that creates an instance of theS3DestinationUpdate.Builder
avoiding the need to create one manually viaS3DestinationUpdate.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tos3Update(S3DestinationUpdate)
.- Parameters:
s3Update
- a consumer that will call methods onS3DestinationUpdate.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
processingConfiguration
AmazonopensearchserviceDestinationUpdate.Builder processingConfiguration(ProcessingConfiguration processingConfiguration) Sets the value of the ProcessingConfiguration property for this object.- Parameters:
processingConfiguration
- The new value for the ProcessingConfiguration property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
processingConfiguration
default AmazonopensearchserviceDestinationUpdate.Builder processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration) Sets the value of the ProcessingConfiguration property for this object. This is a convenience method that creates an instance of theProcessingConfiguration.Builder
avoiding the need to create one manually viaProcessingConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprocessingConfiguration(ProcessingConfiguration)
.- Parameters:
processingConfiguration
- a consumer that will call methods onProcessingConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
cloudWatchLoggingOptions
AmazonopensearchserviceDestinationUpdate.Builder cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) Sets the value of the CloudWatchLoggingOptions property for this object.- Parameters:
cloudWatchLoggingOptions
- The new value for the CloudWatchLoggingOptions property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cloudWatchLoggingOptions
default AmazonopensearchserviceDestinationUpdate.Builder cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions) Sets the value of the CloudWatchLoggingOptions property for this object. This is a convenience method that creates an instance of theCloudWatchLoggingOptions.Builder
avoiding the need to create one manually viaCloudWatchLoggingOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocloudWatchLoggingOptions(CloudWatchLoggingOptions)
.- Parameters:
cloudWatchLoggingOptions
- a consumer that will call methods onCloudWatchLoggingOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
documentIdOptions
AmazonopensearchserviceDestinationUpdate.Builder documentIdOptions(DocumentIdOptions documentIdOptions) Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
- Parameters:
documentIdOptions
- Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentIdOptions
default AmazonopensearchserviceDestinationUpdate.Builder documentIdOptions(Consumer<DocumentIdOptions.Builder> documentIdOptions) Indicates the method for setting up document ID. The supported methods are 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 viaDocumentIdOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todocumentIdOptions(DocumentIdOptions)
.- Parameters:
documentIdOptions
- a consumer that will call methods onDocumentIdOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-