Class CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.kinesisfirehose.CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty>
- Enclosing interface:
CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty
@Stability(Stable)
public static final class CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty>
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbufferingHints(CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessBufferingHintsProperty bufferingHints) bufferingHints(IResolvable bufferingHints) build()Builds the configured instance.cloudWatchLoggingOptions(CfnDeliveryStreamPropsMixin.CloudWatchLoggingOptionsProperty cloudWatchLoggingOptions) cloudWatchLoggingOptions(IResolvable cloudWatchLoggingOptions) collectionEndpoint(String collectionEndpoint) processingConfiguration(CfnDeliveryStreamPropsMixin.ProcessingConfigurationProperty processingConfiguration) processingConfiguration(IResolvable processingConfiguration) retryOptions(CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessRetryOptionsProperty retryOptions) retryOptions(IResolvable retryOptions) s3BackupMode(String s3BackupMode) s3Configuration(IResolvable s3Configuration) vpcConfiguration(CfnDeliveryStreamPropsMixin.VpcConfigurationProperty vpcConfiguration) vpcConfiguration(IResolvable vpcConfiguration)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
bufferingHints
@Stability(Stable) public CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder bufferingHints(IResolvable bufferingHints) Sets the value ofCfnDeliveryStreamPropsMixin.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 CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder bufferingHints(CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessBufferingHintsProperty bufferingHints) Sets the value ofCfnDeliveryStreamPropsMixin.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 CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder cloudWatchLoggingOptions(IResolvable cloudWatchLoggingOptions) Sets the value ofCfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.getCloudWatchLoggingOptions()- Parameters:
cloudWatchLoggingOptions- the value to be set.- Returns:
this
-
cloudWatchLoggingOptions
@Stability(Stable) public CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder cloudWatchLoggingOptions(CfnDeliveryStreamPropsMixin.CloudWatchLoggingOptionsProperty cloudWatchLoggingOptions) Sets the value ofCfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.getCloudWatchLoggingOptions()- Parameters:
cloudWatchLoggingOptions- the value to be set.- Returns:
this
-
collectionEndpoint
@Stability(Stable) public CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder collectionEndpoint(String collectionEndpoint) Sets the value ofCfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.getCollectionEndpoint()- Parameters:
collectionEndpoint- The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.- Returns:
this
-
indexName
@Stability(Stable) public CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder indexName(String indexName) Sets the value ofCfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.getIndexName()- Parameters:
indexName- The Serverless offering for Amazon OpenSearch Service index name.- Returns:
this
-
processingConfiguration
@Stability(Stable) public CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder processingConfiguration(IResolvable processingConfiguration) Sets the value ofCfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.getProcessingConfiguration()- Parameters:
processingConfiguration- the value to be set.- Returns:
this
-
processingConfiguration
@Stability(Stable) public CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder processingConfiguration(CfnDeliveryStreamPropsMixin.ProcessingConfigurationProperty processingConfiguration) Sets the value ofCfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.getProcessingConfiguration()- Parameters:
processingConfiguration- the value to be set.- Returns:
this
-
retryOptions
@Stability(Stable) public CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder retryOptions(IResolvable retryOptions) Sets the value ofCfnDeliveryStreamPropsMixin.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 CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder retryOptions(CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessRetryOptionsProperty retryOptions) Sets the value ofCfnDeliveryStreamPropsMixin.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
-
roleArn
@Stability(Stable) public CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder roleArn(String roleArn) Sets the value ofCfnDeliveryStreamPropsMixin.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.- Returns:
this
-
roleArn
@Stability(Stable) public CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder roleArn(IRoleRef roleArn) Sets the value ofCfnDeliveryStreamPropsMixin.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.- Returns:
this
-
s3BackupMode
@Stability(Stable) public CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder s3BackupMode(String s3BackupMode) Sets the value ofCfnDeliveryStreamPropsMixin.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
-
s3Configuration
@Stability(Stable) public CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder s3Configuration(IResolvable s3Configuration) Sets the value ofCfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.getS3Configuration()- Parameters:
s3Configuration- the value to be set.- Returns:
this
-
s3Configuration
@Stability(Stable) public CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder s3Configuration(CfnDeliveryStreamPropsMixin.S3DestinationConfigurationProperty s3Configuration) Sets the value ofCfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.getS3Configuration()- Parameters:
s3Configuration- the value to be set.- Returns:
this
-
vpcConfiguration
@Stability(Stable) public CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder vpcConfiguration(IResolvable vpcConfiguration) Sets the value ofCfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.getVpcConfiguration()- Parameters:
vpcConfiguration- the value to be set.- Returns:
this
-
vpcConfiguration
@Stability(Stable) public CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder vpcConfiguration(CfnDeliveryStreamPropsMixin.VpcConfigurationProperty vpcConfiguration) Sets the value ofCfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.getVpcConfiguration()- Parameters:
vpcConfiguration- the value to be set.- Returns:
this
-
build
@Stability(Stable) public CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty build()Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty>- Returns:
- a new instance of
CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty - Throws:
NullPointerException- if any required attribute was not provided
-