Package software.amazon.awscdk.services.kinesisfirehose

Class CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

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

A builder for CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	bufferingHints(IResolvable bufferingHints)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getBufferingHints()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	bufferingHints(CfnDeliveryStream.AmazonopensearchserviceBufferingHintsProperty bufferingHints)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getBufferingHints()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty	build()	Builds the configured instance.
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	cloudWatchLoggingOptions(IResolvable cloudWatchLoggingOptions)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getCloudWatchLoggingOptions()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	cloudWatchLoggingOptions(CfnDeliveryStream.CloudWatchLoggingOptionsProperty cloudWatchLoggingOptions)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getCloudWatchLoggingOptions()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	clusterEndpoint(String clusterEndpoint)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getClusterEndpoint()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	documentIdOptions(IResolvable documentIdOptions)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getDocumentIdOptions()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	documentIdOptions(CfnDeliveryStream.DocumentIdOptionsProperty documentIdOptions)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getDocumentIdOptions()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	domainArn(String domainArn)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getDomainArn()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	indexName(String indexName)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getIndexName()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	indexRotationPeriod(String indexRotationPeriod)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getIndexRotationPeriod()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	processingConfiguration(IResolvable processingConfiguration)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getProcessingConfiguration()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	processingConfiguration(CfnDeliveryStream.ProcessingConfigurationProperty processingConfiguration)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getProcessingConfiguration()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	retryOptions(IResolvable retryOptions)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getRetryOptions()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	retryOptions(CfnDeliveryStream.AmazonopensearchserviceRetryOptionsProperty retryOptions)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getRetryOptions()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	roleArn(String roleArn)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getRoleArn()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	s3BackupMode(String s3BackupMode)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getS3BackupMode()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	s3Configuration(IResolvable s3Configuration)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getS3Configuration()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	s3Configuration(CfnDeliveryStream.S3DestinationConfigurationProperty s3Configuration)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getS3Configuration()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	typeName(String typeName)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getTypeName()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	vpcConfiguration(IResolvable vpcConfiguration)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getVpcConfiguration()
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	vpcConfiguration(CfnDeliveryStream.VpcConfigurationProperty vpcConfiguration)	Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.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.AmazonopensearchserviceDestinationConfigurationProperty.Builder indexName(String indexName)

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getIndexName()

Parameters:

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

Returns:

this

roleArn

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

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getRoleArn()

Parameters:

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

Returns:

this

s3Configuration

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

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getS3Configuration()

Parameters:

s3Configuration - Describes the configuration of a destination in Amazon S3. This parameter is required.

Returns:

this

s3Configuration

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

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getS3Configuration()

Parameters:

s3Configuration - Describes the configuration of a destination in Amazon S3. This parameter is required.

Returns:

this

bufferingHints

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

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.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.AmazonopensearchserviceDestinationConfigurationProperty.Builder bufferingHints(CfnDeliveryStream.AmazonopensearchserviceBufferingHintsProperty bufferingHints)

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.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.AmazonopensearchserviceDestinationConfigurationProperty.Builder cloudWatchLoggingOptions(IResolvable cloudWatchLoggingOptions)

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getCloudWatchLoggingOptions()

Parameters:

cloudWatchLoggingOptions - Describes the Amazon CloudWatch logging options for your delivery stream.

Returns:

this

cloudWatchLoggingOptions

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

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getCloudWatchLoggingOptions()

Parameters:

cloudWatchLoggingOptions - Describes the Amazon CloudWatch logging options for your delivery stream.

Returns:

this

clusterEndpoint

@Stability(Stable)
public CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder clusterEndpoint(String clusterEndpoint)

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getClusterEndpoint()

Parameters:

clusterEndpoint - The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

Returns:

this

documentIdOptions

@Stability(Stable)
public CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder documentIdOptions(IResolvable documentIdOptions)

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getDocumentIdOptions()

Parameters:

documentIdOptions - CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.DocumentIdOptions.

Returns:

this

documentIdOptions

@Stability(Stable)
public CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder documentIdOptions(CfnDeliveryStream.DocumentIdOptionsProperty documentIdOptions)

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getDocumentIdOptions()

Parameters:

documentIdOptions - CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.DocumentIdOptions.

Returns:

this

domainArn

@Stability(Stable)
public CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder domainArn(String domainArn)

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getDomainArn()

Parameters:

domainArn - The ARN of the Amazon OpenSearch Service domain.

Returns:

this

indexRotationPeriod

@Stability(Stable)
public CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder indexRotationPeriod(String indexRotationPeriod)

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getIndexRotationPeriod()

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:

this

processingConfiguration

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

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getProcessingConfiguration()

Parameters:

processingConfiguration - Describes a data processing configuration.

Returns:

this

processingConfiguration

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

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getProcessingConfiguration()

Parameters:

processingConfiguration - Describes a data processing configuration.

Returns:

this

retryOptions

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

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getRetryOptions()

Parameters:

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

Returns:

this

retryOptions

@Stability(Stable)
public CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder retryOptions(CfnDeliveryStream.AmazonopensearchserviceRetryOptionsProperty retryOptions)

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getRetryOptions()

Parameters:

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

Returns:

this

s3BackupMode

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

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getS3BackupMode()

Parameters:

s3BackupMode - Defines how documents should be delivered to Amazon S3.

Returns:

this

typeName

@Stability(Stable)
public CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder typeName(String typeName)

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getTypeName()

Parameters:

typeName - The Amazon OpenSearch Service type name.

Returns:

this

vpcConfiguration

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

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getVpcConfiguration()

Parameters:

vpcConfiguration - The details of the VPC of the Amazon OpenSearch Service destination.

Returns:

this

vpcConfiguration

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

Sets the value of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.getVpcConfiguration()

Parameters:

vpcConfiguration - The details of the VPC of the Amazon OpenSearch Service destination.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided