Interface ElasticsearchDestinationConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ElasticsearchDestinationConfiguration.Builder,
,ElasticsearchDestinationConfiguration> SdkBuilder<ElasticsearchDestinationConfiguration.Builder,
,ElasticsearchDestinationConfiguration> SdkPojo
- Enclosing class:
ElasticsearchDestinationConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionbufferingHints
(Consumer<ElasticsearchBufferingHints.Builder> bufferingHints) The buffering options.bufferingHints
(ElasticsearchBufferingHints bufferingHints) The buffering options.cloudWatchLoggingOptions
(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions) The Amazon CloudWatch logging options for your delivery stream.cloudWatchLoggingOptions
(CloudWatchLoggingOptions cloudWatchLoggingOptions) The Amazon CloudWatch logging options for your delivery stream.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 ES domain.The Elasticsearch index name.indexRotationPeriod
(String indexRotationPeriod) The Elasticsearch index rotation period.indexRotationPeriod
(ElasticsearchIndexRotationPeriod indexRotationPeriod) The Elasticsearch index rotation period.processingConfiguration
(Consumer<ProcessingConfiguration.Builder> processingConfiguration) The data processing configuration.processingConfiguration
(ProcessingConfiguration processingConfiguration) The data processing configuration.retryOptions
(Consumer<ElasticsearchRetryOptions.Builder> retryOptions) The retry behavior in case Firehose is unable to deliver documents to Amazon ES.retryOptions
(ElasticsearchRetryOptions retryOptions) The retry behavior in case Firehose is unable to deliver documents to Amazon ES.The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents.s3BackupMode
(String s3BackupMode) Defines how documents should be delivered to Amazon S3.s3BackupMode
(ElasticsearchS3BackupMode s3BackupMode) Defines how documents should be delivered to Amazon S3.s3Configuration
(Consumer<S3DestinationConfiguration.Builder> s3Configuration) The configuration for the backup Amazon S3 location.s3Configuration
(S3DestinationConfiguration s3Configuration) The configuration for the backup Amazon S3 location.The Elasticsearch type name.vpcConfiguration
(Consumer<VpcConfiguration.Builder> vpcConfiguration) The details of the VPC of the Amazon destination.vpcConfiguration
(VpcConfiguration vpcConfiguration) The details of the VPC of the Amazon destination.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 ES Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
- Parameters:
roleARN
- The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainARN
The ARN of the Amazon ES domain. The IAM role must have permissions for
DescribeDomain
,DescribeDomains
, andDescribeDomainConfig
after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.Specify either
ClusterEndpoint
orDomainARN
.- Parameters:
domainARN
- The ARN of the Amazon ES domain. The IAM role must have permissions forDescribeDomain
,DescribeDomains
, andDescribeDomainConfig
after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.Specify either
ClusterEndpoint
orDomainARN
.- 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 theDomainARN
field.- Parameters:
clusterEndpoint
- The endpoint to use when communicating with the cluster. Specify either thisClusterEndpoint
or theDomainARN
field.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
indexName
The Elasticsearch index name.
- Parameters:
indexName
- The Elasticsearch index name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
typeName
The Elasticsearch 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.
For Elasticsearch 7.x, don't specify a
TypeName
.- Parameters:
typeName
- The Elasticsearch 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.For Elasticsearch 7.x, don't specify a
TypeName
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
indexRotationPeriod
The Elasticsearch index rotation period. Index rotation appends a timestamp to the
IndexName
to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value isOneDay
.- Parameters:
indexRotationPeriod
- The Elasticsearch index rotation period. Index rotation appends a timestamp to theIndexName
to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value isOneDay
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
indexRotationPeriod
ElasticsearchDestinationConfiguration.Builder indexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod) The Elasticsearch index rotation period. Index rotation appends a timestamp to the
IndexName
to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value isOneDay
.- Parameters:
indexRotationPeriod
- The Elasticsearch index rotation period. Index rotation appends a timestamp to theIndexName
to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value isOneDay
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
bufferingHints
ElasticsearchDestinationConfiguration.Builder bufferingHints(ElasticsearchBufferingHints bufferingHints) The buffering options. If no value is specified, the default values for
ElasticsearchBufferingHints
are used.- Parameters:
bufferingHints
- The buffering options. If no value is specified, the default values forElasticsearchBufferingHints
are used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bufferingHints
default ElasticsearchDestinationConfiguration.Builder bufferingHints(Consumer<ElasticsearchBufferingHints.Builder> bufferingHints) The buffering options. If no value is specified, the default values for
This is a convenience method that creates an instance of theElasticsearchBufferingHints
are used.ElasticsearchBufferingHints.Builder
avoiding the need to create one manually viaElasticsearchBufferingHints.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobufferingHints(ElasticsearchBufferingHints)
.- Parameters:
bufferingHints
- a consumer that will call methods onElasticsearchBufferingHints.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
retryOptions
The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
- Parameters:
retryOptions
- The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retryOptions
default ElasticsearchDestinationConfiguration.Builder retryOptions(Consumer<ElasticsearchRetryOptions.Builder> retryOptions) The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
This is a convenience method that creates an instance of theElasticsearchRetryOptions.Builder
avoiding the need to create one manually viaElasticsearchRetryOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toretryOptions(ElasticsearchRetryOptions)
.- Parameters:
retryOptions
- a consumer that will call methods onElasticsearchRetryOptions.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, withAmazonOpenSearchService-failed/
appended to the key prefix. When set toAllDocuments
, Firehose delivers all incoming records to Amazon S3, and also writes failed documents withAmazonOpenSearchService-failed/
appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value isFailedDocumentsOnly
.You can't change this backup mode after you create the delivery stream.
- Parameters:
s3BackupMode
- Defines how documents should be delivered to Amazon S3. When it is set toFailedDocumentsOnly
, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, withAmazonOpenSearchService-failed/
appended to the key prefix. When set toAllDocuments
, Firehose delivers all incoming records to Amazon S3, and also writes failed documents withAmazonOpenSearchService-failed/
appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value isFailedDocumentsOnly
.You can't change this backup mode after you create the delivery stream.
- 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, withAmazonOpenSearchService-failed/
appended to the key prefix. When set toAllDocuments
, Firehose delivers all incoming records to Amazon S3, and also writes failed documents withAmazonOpenSearchService-failed/
appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value isFailedDocumentsOnly
.You can't change this backup mode after you create the delivery stream.
- Parameters:
s3BackupMode
- Defines how documents should be delivered to Amazon S3. When it is set toFailedDocumentsOnly
, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, withAmazonOpenSearchService-failed/
appended to the key prefix. When set toAllDocuments
, Firehose delivers all incoming records to Amazon S3, and also writes failed documents withAmazonOpenSearchService-failed/
appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value isFailedDocumentsOnly
.You can't change this backup mode after you create the delivery stream.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
s3Configuration
ElasticsearchDestinationConfiguration.Builder s3Configuration(S3DestinationConfiguration s3Configuration) The configuration for the backup Amazon S3 location.
- Parameters:
s3Configuration
- The configuration for the backup Amazon S3 location.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3Configuration
default ElasticsearchDestinationConfiguration.Builder s3Configuration(Consumer<S3DestinationConfiguration.Builder> s3Configuration) The configuration for the backup Amazon S3 location.
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
ElasticsearchDestinationConfiguration.Builder processingConfiguration(ProcessingConfiguration processingConfiguration) The data processing configuration.
- Parameters:
processingConfiguration
- The data processing configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
processingConfiguration
default ElasticsearchDestinationConfiguration.Builder processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration) The data processing configuration.
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
ElasticsearchDestinationConfiguration.Builder cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) The Amazon CloudWatch logging options for your delivery stream.
- Parameters:
cloudWatchLoggingOptions
- The Amazon CloudWatch logging options for your delivery stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cloudWatchLoggingOptions
default ElasticsearchDestinationConfiguration.Builder cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions) The Amazon CloudWatch logging options for your delivery stream.
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
The details of the VPC of the Amazon destination.
- Parameters:
vpcConfiguration
- The details of the VPC of the Amazon destination.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcConfiguration
default ElasticsearchDestinationConfiguration.Builder vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration) The details of the VPC of the Amazon destination.
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
ElasticsearchDestinationConfiguration.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 ElasticsearchDestinationConfiguration.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:
-