Package software.amazon.awscdk.services.kafkaconnect

Interface CfnConnectorProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConnectorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:58.083Z")
@Stability(Stable)
public interface CfnConnectorProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnConnector.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kafkaconnect.*;
 CfnConnectorProps cfnConnectorProps = CfnConnectorProps.builder()
         .capacity(CapacityProperty.builder()
                 .autoScaling(AutoScalingProperty.builder()
                         .maxWorkerCount(123)
                         .mcuCount(123)
                         .minWorkerCount(123)
                         .scaleInPolicy(ScaleInPolicyProperty.builder()
                                 .cpuUtilizationPercentage(123)
                                 .build())
                         .scaleOutPolicy(ScaleOutPolicyProperty.builder()
                                 .cpuUtilizationPercentage(123)
                                 .build())
                         .build())
                 .provisionedCapacity(ProvisionedCapacityProperty.builder()
                         .workerCount(123)
                         // the properties below are optional
                         .mcuCount(123)
                         .build())
                 .build())
         .connectorConfiguration(Map.of(
                 "connectorConfigurationKey", "connectorConfiguration"))
         .connectorName("connectorName")
         .kafkaCluster(KafkaClusterProperty.builder()
                 .apacheKafkaCluster(ApacheKafkaClusterProperty.builder()
                         .bootstrapServers("bootstrapServers")
                         .vpc(VpcProperty.builder()
                                 .securityGroups(List.of("securityGroups"))
                                 .subnets(List.of("subnets"))
                                 .build())
                         .build())
                 .build())
         .kafkaClusterClientAuthentication(KafkaClusterClientAuthenticationProperty.builder()
                 .authenticationType("authenticationType")
                 .build())
         .kafkaClusterEncryptionInTransit(KafkaClusterEncryptionInTransitProperty.builder()
                 .encryptionType("encryptionType")
                 .build())
         .kafkaConnectVersion("kafkaConnectVersion")
         .plugins(List.of(PluginProperty.builder()
                 .customPlugin(CustomPluginProperty.builder()
                         .customPluginArn("customPluginArn")
                         .revision(123)
                         .build())
                 .build()))
         .serviceExecutionRoleArn("serviceExecutionRoleArn")
         // the properties below are optional
         .connectorDescription("connectorDescription")
         .logDelivery(LogDeliveryProperty.builder()
                 .workerLogDelivery(WorkerLogDeliveryProperty.builder()
                         .cloudWatchLogs(CloudWatchLogsLogDeliveryProperty.builder()
                                 .enabled(false)
                                 // the properties below are optional
                                 .logGroup("logGroup")
                                 .build())
                         .firehose(FirehoseLogDeliveryProperty.builder()
                                 .enabled(false)
                                 // the properties below are optional
                                 .deliveryStream("deliveryStream")
                                 .build())
                         .s3(S3LogDeliveryProperty.builder()
                                 .enabled(false)
                                 // the properties below are optional
                                 .bucket("bucket")
                                 .prefix("prefix")
                                 .build())
                         .build())
                 .build())
         .workerConfiguration(WorkerConfigurationProperty.builder()
                 .revision(123)
                 .workerConfigurationArn("workerConfigurationArn")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConnectorProps.Builder	A builder for CfnConnectorProps
static final class	CfnConnectorProps.Jsii$Proxy	An implementation for CfnConnectorProps

Method Summary

Modifier and Type	Method	Description
static CfnConnectorProps.Builder	builder()
Object	getCapacity()	The connector's compute capacity settings.
Object	getConnectorConfiguration()	The configuration of the connector.
default String	getConnectorDescription()	The description of the connector.
String	getConnectorName()	The name of the connector.
Object	getKafkaCluster()	The details of the Apache Kafka cluster to which the connector is connected.
Object	getKafkaClusterClientAuthentication()	The type of client authentication used to connect to the Apache Kafka cluster.
Object	getKafkaClusterEncryptionInTransit()	Details of encryption in transit to the Apache Kafka cluster.
String	getKafkaConnectVersion()	The version of Kafka Connect.
default Object	getLogDelivery()	The settings for delivering connector logs to Amazon CloudWatch Logs.
Object	getPlugins()	Specifies which plugin to use for the connector.
String	getServiceExecutionRoleArn()	The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
default Object	getWorkerConfiguration()	The worker configurations that are in use with the connector.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCapacity

@Stability(Stable)
@NotNull
Object getCapacity()

The connector's compute capacity settings.

getConnectorConfiguration

@Stability(Stable)
@NotNull
Object getConnectorConfiguration()

The configuration of the connector.

getConnectorName

@Stability(Stable)
@NotNull
String getConnectorName()

The name of the connector.

getKafkaCluster

@Stability(Stable)
@NotNull
Object getKafkaCluster()

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

getKafkaClusterClientAuthentication

@Stability(Stable)
@NotNull
Object getKafkaClusterClientAuthentication()

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

The value is NONE when no client authentication is used.

getKafkaClusterEncryptionInTransit

@Stability(Stable)
@NotNull
Object getKafkaClusterEncryptionInTransit()

Details of encryption in transit to the Apache Kafka cluster.

getKafkaConnectVersion

@Stability(Stable)
@NotNull
String getKafkaConnectVersion()

The version of Kafka Connect.

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

getPlugins

@Stability(Stable)
@NotNull
Object getPlugins()

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.

getServiceExecutionRoleArn

@Stability(Stable)
@NotNull
String getServiceExecutionRoleArn()

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

getConnectorDescription

@Stability(Stable)
@Nullable
default String getConnectorDescription()

The description of the connector.

getLogDelivery

@Stability(Stable)
@Nullable
default Object getLogDelivery()

The settings for delivering connector logs to Amazon CloudWatch Logs.

getWorkerConfiguration

@Stability(Stable)
@Nullable
default Object getWorkerConfiguration()

The worker configurations that are in use with the connector.

builder

@Stability(Stable)
static CfnConnectorProps.Builder builder()

Returns:

a CfnConnectorProps.Builder of CfnConnectorProps