Package software.amazon.awscdk.cfnpropertymixins.services.kinesisfirehose

Class CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.kinesisfirehose.CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty

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

A builder for CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

bufferingHints

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

Sets the value of CfnDeliveryStreamPropsMixin.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 CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.Builder bufferingHints(CfnDeliveryStreamPropsMixin.ElasticsearchBufferingHintsProperty bufferingHints)

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

Sets the value of CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.getCloudWatchLoggingOptions()

Parameters:

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

Returns:

this

cloudWatchLoggingOptions

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

Sets the value of CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.getCloudWatchLoggingOptions()

Parameters:

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

Returns:

this

clusterEndpoint

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

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

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

Sets the value of CfnDeliveryStreamPropsMixin.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 CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.Builder domainArn(String domainArn)

Sets the value of CfnDeliveryStreamPropsMixin.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

domainArn

@Stability(Stable)
public CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.Builder domainArn(IDomainRef domainArn)

Sets the value of CfnDeliveryStreamPropsMixin.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

domainArn

@Stability(Stable)
public CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.Builder domainArn(IDomainRef domainArn)

Sets the value of CfnDeliveryStreamPropsMixin.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

indexName

@Stability(Stable)
public CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.Builder indexName(String indexName)

Sets the value of CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.getIndexName()

Parameters:

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

Returns:

this

indexRotationPeriod

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

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

Sets the value of CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.getProcessingConfiguration()

Parameters:

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

Returns:

this

processingConfiguration

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

Sets the value of CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.getProcessingConfiguration()

Parameters:

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

Returns:

this

retryOptions

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

Sets the value of CfnDeliveryStreamPropsMixin.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 CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.Builder retryOptions(CfnDeliveryStreamPropsMixin.ElasticsearchRetryOptionsProperty retryOptions)

Sets the value of CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.getRetryOptions()

Parameters:

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

Returns:

this

roleArn

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

Sets the value of CfnDeliveryStreamPropsMixin.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. For more information, see Controlling Access with Amazon Kinesis Data Firehose .

Returns:

this

roleArn

@Stability(Stable)
public CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.Builder roleArn(IRoleRef roleArn)

Sets the value of CfnDeliveryStreamPropsMixin.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. For more information, see Controlling Access with Amazon Kinesis Data Firehose .

Returns:

this

s3BackupMode

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

Sets the value of CfnDeliveryStreamPropsMixin.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

s3Configuration

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

Sets the value of CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.getS3Configuration()

Parameters:

s3Configuration - The S3 bucket where Kinesis Data Firehose backs up incoming data.

Returns:

this

s3Configuration

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

Sets the value of CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.getS3Configuration()

Parameters:

s3Configuration - The S3 bucket where Kinesis Data Firehose backs up incoming data.

Returns:

this

typeName

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

Sets the value of CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.getTypeName()

Parameters:

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

Returns:

this

vpcConfiguration

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

Sets the value of CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.getVpcConfiguration()

Parameters:

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

Returns:

this

vpcConfiguration

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

Sets the value of CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty.getVpcConfiguration()

Parameters:

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

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided