Package software.amazon.awscdk.services.kinesisfirehose

Class CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

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

A builder for CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getIndexName()

Parameters:

indexName - The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing. This parameter is required.

Returns:

this

roleArn

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getRoleArn()

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. This parameter is required. For more information, see Controlling Access with Amazon Kinesis Data Firehose .

Returns:

this

s3Configuration

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getS3Configuration()

Parameters:

s3Configuration - The S3 bucket where Kinesis Data Firehose backs up incoming data. This parameter is required.

Returns:

this

s3Configuration

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getS3Configuration()

Parameters:

s3Configuration - The S3 bucket where Kinesis Data Firehose backs up incoming data. This parameter is required.

Returns:

this

bufferingHints

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getBufferingHints()

Parameters:

bufferingHints - Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.

Returns:

this

bufferingHints

@Stability(Stable)
public CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Builder bufferingHints(CfnDeliveryStream.ElasticsearchBufferingHintsProperty bufferingHints)

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getBufferingHints()

Parameters:

bufferingHints - Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.

Returns:

this

cloudWatchLoggingOptions

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getCloudWatchLoggingOptions()

Parameters:

cloudWatchLoggingOptions - The Amazon CloudWatch Logs logging options for the delivery stream.

Returns:

this

cloudWatchLoggingOptions

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getCloudWatchLoggingOptions()

Parameters:

cloudWatchLoggingOptions - The Amazon CloudWatch Logs logging options for the delivery stream.

Returns:

this

clusterEndpoint

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

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getDocumentIdOptions()

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:

this

documentIdOptions

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getDocumentIdOptions()

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:

this

domainArn

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getDomainArn()

Parameters:

domainArn - The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain , DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN .

Specify either ClusterEndpoint or DomainARN .

Returns:

this

indexRotationPeriod

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getIndexRotationPeriod()

Parameters:

indexRotationPeriod - The frequency of Elasticsearch index rotation. If you enable index rotation, Kinesis Data Firehose appends a portion of the UTC arrival timestamp to the specified index name, and rotates the appended timestamp accordingly. For more information, see Index Rotation for the Amazon ES Destination in the Amazon Kinesis Data Firehose Developer Guide .

Returns:

this

processingConfiguration

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getProcessingConfiguration()

Parameters:

processingConfiguration - The data processing configuration for the Kinesis Data Firehose delivery stream.

Returns:

this

processingConfiguration

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getProcessingConfiguration()

Parameters:

processingConfiguration - The data processing configuration for the Kinesis Data Firehose delivery stream.

Returns:

this

retryOptions

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getRetryOptions()

Parameters:

retryOptions - The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.

Returns:

this

retryOptions

@Stability(Stable)
public CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Builder retryOptions(CfnDeliveryStream.ElasticsearchRetryOptionsProperty retryOptions)

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getRetryOptions()

Parameters:

retryOptions - The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.

Returns:

this

s3BackupMode

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getS3BackupMode()

Parameters:

s3BackupMode - The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3). You can send Amazon S3 all documents (all data) or only the documents that Kinesis Data Firehose could not deliver to the Amazon ES destination. For more information and valid values, see the S3BackupMode content for the ElasticsearchDestinationConfiguration data type in the Amazon Kinesis Data Firehose API Reference .

Returns:

this

typeName

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getTypeName()

Parameters:

typeName - The Elasticsearch type name that Amazon ES adds to documents when indexing data.

Returns:

this

vpcConfiguration

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getVpcConfiguration()

Parameters:

vpcConfiguration - The details of the VPC of the Amazon ES destination.

Returns:

this

vpcConfiguration

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

Sets the value of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.getVpcConfiguration()

Parameters:

vpcConfiguration - The details of the VPC of the Amazon ES destination.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided