Package software.amazon.awscdk.cfnpropertymixins.services.kafkaconnect

Class CfnConnectorPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.kafkaconnect.CfnConnectorPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnConnectorPropsMixin>

Enclosing class:

CfnConnectorPropsMixin

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

A fluent builder for CfnConnectorPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnConnectorPropsMixin	build()
CfnConnectorPropsMixin.Builder	capacity(CfnConnectorPropsMixin.CapacityProperty capacity)	The connector's compute capacity settings.
CfnConnectorPropsMixin.Builder	capacity(IResolvable capacity)	The connector's compute capacity settings.
CfnConnectorPropsMixin.Builder	connectorConfiguration(Map<String,String> connectorConfiguration)	The configuration of the connector.
CfnConnectorPropsMixin.Builder	connectorConfiguration(IResolvable connectorConfiguration)	The configuration of the connector.
CfnConnectorPropsMixin.Builder	connectorDescription(String connectorDescription)	The description of the connector.
CfnConnectorPropsMixin.Builder	connectorName(String connectorName)	The name of the connector.
static CfnConnectorPropsMixin.Builder	create()
static CfnConnectorPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnConnectorPropsMixin.Builder	kafkaCluster(CfnConnectorPropsMixin.KafkaClusterProperty kafkaCluster)	The details of the Apache Kafka cluster to which the connector is connected.
CfnConnectorPropsMixin.Builder	kafkaCluster(IResolvable kafkaCluster)	The details of the Apache Kafka cluster to which the connector is connected.
CfnConnectorPropsMixin.Builder	kafkaClusterClientAuthentication(CfnConnectorPropsMixin.KafkaClusterClientAuthenticationProperty kafkaClusterClientAuthentication)	The type of client authentication used to connect to the Apache Kafka cluster.
CfnConnectorPropsMixin.Builder	kafkaClusterClientAuthentication(IResolvable kafkaClusterClientAuthentication)	The type of client authentication used to connect to the Apache Kafka cluster.
CfnConnectorPropsMixin.Builder	kafkaClusterEncryptionInTransit(CfnConnectorPropsMixin.KafkaClusterEncryptionInTransitProperty kafkaClusterEncryptionInTransit)	Details of encryption in transit to the Apache Kafka cluster.
CfnConnectorPropsMixin.Builder	kafkaClusterEncryptionInTransit(IResolvable kafkaClusterEncryptionInTransit)	Details of encryption in transit to the Apache Kafka cluster.
CfnConnectorPropsMixin.Builder	kafkaConnectVersion(String kafkaConnectVersion)	The version of Kafka Connect.
CfnConnectorPropsMixin.Builder	logDelivery(CfnConnectorPropsMixin.LogDeliveryProperty logDelivery)	The settings for delivering connector logs to Amazon CloudWatch Logs.
CfnConnectorPropsMixin.Builder	logDelivery(IResolvable logDelivery)	The settings for delivering connector logs to Amazon CloudWatch Logs.
CfnConnectorPropsMixin.Builder	networkType(String networkType)	The network type of the connector.
CfnConnectorPropsMixin.Builder	plugins(List<? extends Object> plugins)	Specifies which plugin to use for the connector.
CfnConnectorPropsMixin.Builder	plugins(IResolvable plugins)	Specifies which plugin to use for the connector.
CfnConnectorPropsMixin.Builder	serviceExecutionRoleArn(String serviceExecutionRoleArn)	The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
CfnConnectorPropsMixin.Builder	tags(List<? extends CfnTag> tags)	A collection of tags associated with a resource.
CfnConnectorPropsMixin.Builder	workerConfiguration(CfnConnectorPropsMixin.WorkerConfigurationProperty workerConfiguration)	The worker configurations that are in use with the connector.
CfnConnectorPropsMixin.Builder	workerConfiguration(IResolvable workerConfiguration)	The worker configurations that are in use with the connector.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnConnectorPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnConnectorPropsMixin.Builder.

create

@Stability(Stable)
public static CfnConnectorPropsMixin.Builder create()

Returns:

a new instance of CfnConnectorPropsMixin.Builder.

capacity

@Stability(Stable)
public CfnConnectorPropsMixin.Builder capacity(IResolvable capacity)

The connector's compute capacity settings.

Parameters:

capacity - The connector's compute capacity settings. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-capacity

capacity

@Stability(Stable)
public CfnConnectorPropsMixin.Builder capacity(CfnConnectorPropsMixin.CapacityProperty capacity)

The connector's compute capacity settings.

Parameters:

capacity - The connector's compute capacity settings. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-capacity

connectorConfiguration

@Stability(Stable)
public CfnConnectorPropsMixin.Builder connectorConfiguration(Map<String,String> connectorConfiguration)

The configuration of the connector.

Parameters:

connectorConfiguration - The configuration of the connector. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-connectorconfiguration

connectorConfiguration

@Stability(Stable)
public CfnConnectorPropsMixin.Builder connectorConfiguration(IResolvable connectorConfiguration)

The configuration of the connector.

Parameters:

connectorConfiguration - The configuration of the connector. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-connectorconfiguration

connectorDescription

@Stability(Stable)
public CfnConnectorPropsMixin.Builder connectorDescription(String connectorDescription)

The description of the connector.

Parameters:

connectorDescription - The description of the connector. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-connectordescription

connectorName

@Stability(Stable)
public CfnConnectorPropsMixin.Builder connectorName(String connectorName)

The name of the connector.

The connector name must be unique and can include up to 128 characters. Valid characters you can include in a connector name are: a-z, A-Z, 0-9, and -.

Parameters:

connectorName - The name of the connector. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-connectorname

kafkaCluster

@Stability(Stable)
public CfnConnectorPropsMixin.Builder kafkaCluster(IResolvable kafkaCluster)

The details of the Apache Kafka cluster to which the connector is connected.

Parameters:

kafkaCluster - The details of the Apache Kafka cluster to which the connector is connected. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-kafkacluster

kafkaCluster

@Stability(Stable)
public CfnConnectorPropsMixin.Builder kafkaCluster(CfnConnectorPropsMixin.KafkaClusterProperty kafkaCluster)

The details of the Apache Kafka cluster to which the connector is connected.

Parameters:

kafkaCluster - The details of the Apache Kafka cluster to which the connector is connected. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-kafkacluster

kafkaClusterClientAuthentication

@Stability(Stable)
public CfnConnectorPropsMixin.Builder kafkaClusterClientAuthentication(IResolvable kafkaClusterClientAuthentication)

The type of client authentication used to connect to the Apache Kafka cluster.

The value is NONE when no client authentication is used.

Parameters:

kafkaClusterClientAuthentication - The type of client authentication used to connect to the Apache Kafka cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-kafkaclusterclientauthentication

kafkaClusterClientAuthentication

@Stability(Stable)
public CfnConnectorPropsMixin.Builder kafkaClusterClientAuthentication(CfnConnectorPropsMixin.KafkaClusterClientAuthenticationProperty kafkaClusterClientAuthentication)

The type of client authentication used to connect to the Apache Kafka cluster.

The value is NONE when no client authentication is used.

Parameters:

kafkaClusterClientAuthentication - The type of client authentication used to connect to the Apache Kafka cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-kafkaclusterclientauthentication

kafkaClusterEncryptionInTransit

@Stability(Stable)
public CfnConnectorPropsMixin.Builder kafkaClusterEncryptionInTransit(IResolvable kafkaClusterEncryptionInTransit)

Details of encryption in transit to the Apache Kafka cluster.

Parameters:

kafkaClusterEncryptionInTransit - Details of encryption in transit to the Apache Kafka cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-kafkaclusterencryptionintransit

kafkaClusterEncryptionInTransit

@Stability(Stable)
public CfnConnectorPropsMixin.Builder kafkaClusterEncryptionInTransit(CfnConnectorPropsMixin.KafkaClusterEncryptionInTransitProperty kafkaClusterEncryptionInTransit)

Details of encryption in transit to the Apache Kafka cluster.

Parameters:

kafkaClusterEncryptionInTransit - Details of encryption in transit to the Apache Kafka cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-kafkaclusterencryptionintransit

kafkaConnectVersion

@Stability(Stable)
public CfnConnectorPropsMixin.Builder kafkaConnectVersion(String kafkaConnectVersion)

The version of Kafka Connect.

It has to be compatible with both the Apache Kafka cluster's version and the plugins.

Parameters:

kafkaConnectVersion - The version of Kafka Connect. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-kafkaconnectversion

logDelivery

@Stability(Stable)
public CfnConnectorPropsMixin.Builder logDelivery(IResolvable logDelivery)

The settings for delivering connector logs to Amazon CloudWatch Logs.

Parameters:

logDelivery - The settings for delivering connector logs to Amazon CloudWatch Logs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-logdelivery

logDelivery

@Stability(Stable)
public CfnConnectorPropsMixin.Builder logDelivery(CfnConnectorPropsMixin.LogDeliveryProperty logDelivery)

The settings for delivering connector logs to Amazon CloudWatch Logs.

Parameters:

logDelivery - The settings for delivering connector logs to Amazon CloudWatch Logs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-logdelivery

networkType

@Stability(Stable)
public CfnConnectorPropsMixin.Builder networkType(String networkType)

The network type of the connector.

It gives connectors connectivity to either IPv4 (IPV4) or IPv4 and IPv6 (DUAL) destinations. Defaults to IPV4.

Parameters:

networkType - The network type of the connector. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-networktype

plugins

@Stability(Stable)
public CfnConnectorPropsMixin.Builder plugins(IResolvable plugins)

Specifies which plugin to use for the connector.

You must specify a single-element list. Amazon MSK Connect does not currently support specifying multiple plugins.

Parameters:

plugins - Specifies which plugin to use for the connector. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-plugins

plugins

@Stability(Stable)
public CfnConnectorPropsMixin.Builder plugins(List<? extends Object> plugins)

Specifies which plugin to use for the connector.

You must specify a single-element list. Amazon MSK Connect does not currently support specifying multiple plugins.

Parameters:

plugins - Specifies which plugin to use for the connector. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-plugins

serviceExecutionRoleArn

@Stability(Stable)
public CfnConnectorPropsMixin.Builder serviceExecutionRoleArn(String serviceExecutionRoleArn)

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

Parameters:

serviceExecutionRoleArn - The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-serviceexecutionrolearn

tags

@Stability(Stable)
public CfnConnectorPropsMixin.Builder tags(List<? extends CfnTag> tags)

A collection of tags associated with a resource.

Parameters:

tags - A collection of tags associated with a resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-tags

workerConfiguration

@Stability(Stable)
public CfnConnectorPropsMixin.Builder workerConfiguration(IResolvable workerConfiguration)

The worker configurations that are in use with the connector.

Parameters:

workerConfiguration - The worker configurations that are in use with the connector. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-workerconfiguration

workerConfiguration

@Stability(Stable)
public CfnConnectorPropsMixin.Builder workerConfiguration(CfnConnectorPropsMixin.WorkerConfigurationProperty workerConfiguration)

The worker configurations that are in use with the connector.

Parameters:

workerConfiguration - The worker configurations that are in use with the connector. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-workerconfiguration

build

@Stability(Stable)
public CfnConnectorPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnConnectorPropsMixin>

Returns:

a newly built instance of CfnConnectorPropsMixin.