Interface AmazonopensearchserviceDestinationConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AmazonopensearchserviceDestinationConfiguration.Builder,
,AmazonopensearchserviceDestinationConfiguration> SdkBuilder<AmazonopensearchserviceDestinationConfiguration.Builder,
,AmazonopensearchserviceDestinationConfiguration> SdkPojo
- Enclosing class:
AmazonopensearchserviceDestinationConfiguration
-
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 ElasticsearAmazon 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.s3BackupMode
(String s3BackupMode) Defines how documents should be delivered to Amazon S3.s3BackupMode
(AmazonopensearchserviceS3BackupMode s3BackupMode) Defines how documents should be delivered to Amazon S3.s3Configuration
(Consumer<S3DestinationConfiguration.Builder> s3Configuration) Sets the value of the S3Configuration property for this object.s3Configuration
(S3DestinationConfiguration s3Configuration) Sets the value of the S3Configuration property for this object.The Amazon OpenSearch Service type name.vpcConfiguration
(Consumer<VpcConfiguration.Builder> vpcConfiguration) Sets the value of the VpcConfiguration property for this object.vpcConfiguration
(VpcConfiguration vpcConfiguration) Sets the value of the VpcConfiguration property for this object.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 DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.
- Parameters:
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.- 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 ElasticsearAmazon OpenSearch Service index name.
- Parameters:
indexName
- The ElasticsearAmazon 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 run time.
- 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 run time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
indexRotationPeriod
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.
- Parameters:
indexRotationPeriod
- The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the 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
AmazonopensearchserviceDestinationConfiguration.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.
- Parameters:
indexRotationPeriod
- The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the 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
AmazonopensearchserviceDestinationConfiguration.Builder bufferingHints(AmazonopensearchserviceBufferingHints bufferingHints) The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
- Parameters:
bufferingHints
- The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bufferingHints
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 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
AmazonopensearchserviceDestinationConfiguration.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 AmazonopensearchserviceDestinationConfiguration.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:
-
s3BackupMode
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, 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, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
- Parameters:
s3BackupMode
- Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, 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, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
s3BackupMode
AmazonopensearchserviceDestinationConfiguration.Builder s3BackupMode(AmazonopensearchserviceS3BackupMode s3BackupMode) Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, 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, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
- Parameters:
s3BackupMode
- Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, 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, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
s3Configuration
AmazonopensearchserviceDestinationConfiguration.Builder s3Configuration(S3DestinationConfiguration s3Configuration) Sets the value of the S3Configuration property for this object.- Parameters:
s3Configuration
- The new value for the S3Configuration property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3Configuration
default AmazonopensearchserviceDestinationConfiguration.Builder s3Configuration(Consumer<S3DestinationConfiguration.Builder> s3Configuration) Sets the value of the S3Configuration property for this object. This is a convenience method that creates an instance of theS3DestinationConfiguration.Builder
avoiding the need to create one manually viaS3DestinationConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tos3Configuration(S3DestinationConfiguration)
.- Parameters:
s3Configuration
- a consumer that will call methods onS3DestinationConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
processingConfiguration
AmazonopensearchserviceDestinationConfiguration.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 AmazonopensearchserviceDestinationConfiguration.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
AmazonopensearchserviceDestinationConfiguration.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 AmazonopensearchserviceDestinationConfiguration.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:
-
vpcConfiguration
AmazonopensearchserviceDestinationConfiguration.Builder vpcConfiguration(VpcConfiguration vpcConfiguration) Sets the value of the VpcConfiguration property for this object.- Parameters:
vpcConfiguration
- The new value for the VpcConfiguration property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcConfiguration
default AmazonopensearchserviceDestinationConfiguration.Builder vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration) Sets the value of the VpcConfiguration property for this object. This is a convenience method that creates an instance of theVpcConfiguration.Builder
avoiding the need to create one manually viaVpcConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovpcConfiguration(VpcConfiguration)
.- Parameters:
vpcConfiguration
- a consumer that will call methods onVpcConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
documentIdOptions
AmazonopensearchserviceDestinationConfiguration.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 AmazonopensearchserviceDestinationConfiguration.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:
-