Package software.amazon.awscdk.services.kinesisfirehose

Class CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty>

Enclosing interface:

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty

@Stability(Stable)
public static final class CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty>

A builder for CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	bufferingHints(IResolvable bufferingHints)	Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getBufferingHints()
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	bufferingHints(CfnDeliveryStream.AmazonOpenSearchServerlessBufferingHintsProperty bufferingHints)	Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getBufferingHints()
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty	build()	Builds the configured instance.
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	cloudWatchLoggingOptions(IResolvable cloudWatchLoggingOptions)	Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getCloudWatchLoggingOptions()
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	cloudWatchLoggingOptions(CfnDeliveryStream.CloudWatchLoggingOptionsProperty cloudWatchLoggingOptions)	Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getCloudWatchLoggingOptions()
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	collectionEndpoint(String collectionEndpoint)	Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getCollectionEndpoint()
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	indexName(String indexName)	Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getIndexName()
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	processingConfiguration(IResolvable processingConfiguration)	Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getProcessingConfiguration()
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	processingConfiguration(CfnDeliveryStream.ProcessingConfigurationProperty processingConfiguration)	Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getProcessingConfiguration()
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	retryOptions(IResolvable retryOptions)	Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getRetryOptions()
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	retryOptions(CfnDeliveryStream.AmazonOpenSearchServerlessRetryOptionsProperty retryOptions)	Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getRetryOptions()
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	roleArn(String roleArn)	Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getRoleArn()
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	s3BackupMode(String s3BackupMode)	Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getS3BackupMode()
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	s3Configuration(IResolvable s3Configuration)	Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getS3Configuration()
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	s3Configuration(CfnDeliveryStream.S3DestinationConfigurationProperty s3Configuration)	Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getS3Configuration()
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	vpcConfiguration(IResolvable vpcConfiguration)	Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getVpcConfiguration()
CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	vpcConfiguration(CfnDeliveryStream.VpcConfigurationProperty vpcConfiguration)	Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getVpcConfiguration()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

indexName

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder indexName(String indexName)

Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getIndexName()

Parameters:

indexName - The Serverless offering for Amazon OpenSearch Service index name. This parameter is required.

Returns:

this

roleArn

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder roleArn(String roleArn)

Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getRoleArn()

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents. This parameter is required.

Returns:

this

s3Configuration

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder s3Configuration(IResolvable s3Configuration)

Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getS3Configuration()

Parameters:

s3Configuration - the value to be set. This parameter is required.

Returns:

this

s3Configuration

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder s3Configuration(CfnDeliveryStream.S3DestinationConfigurationProperty s3Configuration)

Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getS3Configuration()

Parameters:

s3Configuration - the value to be set. This parameter is required.

Returns:

this

bufferingHints

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder bufferingHints(IResolvable bufferingHints)

Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getBufferingHints()

Parameters:

bufferingHints - The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.

Returns:

this

bufferingHints

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder bufferingHints(CfnDeliveryStream.AmazonOpenSearchServerlessBufferingHintsProperty bufferingHints)

Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getBufferingHints()

Parameters:

bufferingHints - The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.

Returns:

this

cloudWatchLoggingOptions

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder cloudWatchLoggingOptions(IResolvable cloudWatchLoggingOptions)

Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getCloudWatchLoggingOptions()

Parameters:

cloudWatchLoggingOptions - the value to be set.

Returns:

this

cloudWatchLoggingOptions

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder cloudWatchLoggingOptions(CfnDeliveryStream.CloudWatchLoggingOptionsProperty cloudWatchLoggingOptions)

Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getCloudWatchLoggingOptions()

Parameters:

cloudWatchLoggingOptions - the value to be set.

Returns:

this

collectionEndpoint

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder collectionEndpoint(String collectionEndpoint)

Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getCollectionEndpoint()

Parameters:

collectionEndpoint - The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

Returns:

this

processingConfiguration

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder processingConfiguration(IResolvable processingConfiguration)

Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getProcessingConfiguration()

Parameters:

processingConfiguration - the value to be set.

Returns:

this

processingConfiguration

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder processingConfiguration(CfnDeliveryStream.ProcessingConfigurationProperty processingConfiguration)

Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getProcessingConfiguration()

Parameters:

processingConfiguration - the value to be set.

Returns:

this

retryOptions

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder retryOptions(IResolvable retryOptions)

Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getRetryOptions()

Parameters:

retryOptions - The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).

Returns:

this

retryOptions

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder retryOptions(CfnDeliveryStream.AmazonOpenSearchServerlessRetryOptionsProperty retryOptions)

Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getRetryOptions()

Parameters:

retryOptions - The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).

Returns:

this

s3BackupMode

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder s3BackupMode(String s3BackupMode)

Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getS3BackupMode()

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:

this

vpcConfiguration

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder vpcConfiguration(IResolvable vpcConfiguration)

Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getVpcConfiguration()

Parameters:

vpcConfiguration - the value to be set.

Returns:

this

vpcConfiguration

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder vpcConfiguration(CfnDeliveryStream.VpcConfigurationProperty vpcConfiguration)

Sets the value of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.getVpcConfiguration()

Parameters:

vpcConfiguration - the value to be set.

Returns:

this

build

@Stability(Stable)
public CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty>

Returns:

a new instance of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided