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.57.0 (build f614666)",
           date="2022-04-22T22:36:23.166Z")
 @Stability(value=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 and Description
static class	CfnConnectorProps.Builder A builder for CfnConnectorProps
static class	CfnConnectorProps.Jsii$Proxy An implementation for CfnConnectorProps

Method Summary

Modifier and Type	Method and Description
static CfnConnectorProps.Builder	builder()
Object	getCapacity() `AWS::KafkaConnect::Connector.Capacity`.
Object	getConnectorConfiguration() `AWS::KafkaConnect::Connector.ConnectorConfiguration`.
default String	getConnectorDescription() `AWS::KafkaConnect::Connector.ConnectorDescription`.
String	getConnectorName() `AWS::KafkaConnect::Connector.ConnectorName`.
Object	getKafkaCluster() `AWS::KafkaConnect::Connector.KafkaCluster`.
Object	getKafkaClusterClientAuthentication() `AWS::KafkaConnect::Connector.KafkaClusterClientAuthentication`.
Object	getKafkaClusterEncryptionInTransit() `AWS::KafkaConnect::Connector.KafkaClusterEncryptionInTransit`.
String	getKafkaConnectVersion() `AWS::KafkaConnect::Connector.KafkaConnectVersion`.
default Object	getLogDelivery() `AWS::KafkaConnect::Connector.LogDelivery`.
Object	getPlugins() `AWS::KafkaConnect::Connector.Plugins`.
String	getServiceExecutionRoleArn() `AWS::KafkaConnect::Connector.ServiceExecutionRoleArn`.
default Object	getWorkerConfiguration() `AWS::KafkaConnect::Connector.WorkerConfiguration`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCapacity

@Stability(value=Stable)
 @NotNull
Object getCapacity()

`AWS::KafkaConnect::Connector.Capacity`.

getConnectorConfiguration

@Stability(value=Stable)
 @NotNull
Object getConnectorConfiguration()

`AWS::KafkaConnect::Connector.ConnectorConfiguration`.

getConnectorName

@Stability(value=Stable)
 @NotNull
String getConnectorName()

`AWS::KafkaConnect::Connector.ConnectorName`.

getKafkaCluster

@Stability(value=Stable)
 @NotNull
Object getKafkaCluster()

`AWS::KafkaConnect::Connector.KafkaCluster`.

getKafkaClusterClientAuthentication

@Stability(value=Stable)
 @NotNull
Object getKafkaClusterClientAuthentication()

`AWS::KafkaConnect::Connector.KafkaClusterClientAuthentication`.

getKafkaClusterEncryptionInTransit

@Stability(value=Stable)
 @NotNull
Object getKafkaClusterEncryptionInTransit()

`AWS::KafkaConnect::Connector.KafkaClusterEncryptionInTransit`.

getKafkaConnectVersion

@Stability(value=Stable)
 @NotNull
String getKafkaConnectVersion()

`AWS::KafkaConnect::Connector.KafkaConnectVersion`.

getPlugins

@Stability(value=Stable)
 @NotNull
Object getPlugins()

`AWS::KafkaConnect::Connector.Plugins`.

getServiceExecutionRoleArn

@Stability(value=Stable)
 @NotNull
String getServiceExecutionRoleArn()

`AWS::KafkaConnect::Connector.ServiceExecutionRoleArn`.

getConnectorDescription

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

`AWS::KafkaConnect::Connector.ConnectorDescription`.

getLogDelivery

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

`AWS::KafkaConnect::Connector.LogDelivery`.

getWorkerConfiguration

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

`AWS::KafkaConnect::Connector.WorkerConfiguration`.

builder

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

Returns:

a CfnConnectorProps.Builder of CfnConnectorProps