Class CfnConnector

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:03.546Z") @Stability(Stable) public class CfnConnector extends CfnResource implements IInspectable, ITaggableV2
Creates a connector using the specified properties.

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.*;
 CfnConnector cfnConnector = CfnConnector.Builder.create(this, "MyCfnConnector")
         .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())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .workerConfiguration(WorkerConfigurationProperty.builder()
                 .revision(123)
                 .workerConfigurationArn("workerConfigurationArn")
                 .build())
         .build();
 

See Also:
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnConnector

      protected CfnConnector(software.amazon.jsii.JsiiObjectRef objRef)
    • CfnConnector

      protected CfnConnector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • CfnConnector

      @Stability(Stable) public CfnConnector(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnConnectorProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.
  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.
    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.
    • getAttrConnectorArn

      @Stability(Stable) @NotNull public String getAttrConnectorArn()
      The Amazon Resource Name (ARN) of the newly created connector.
    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getCapacity

      @Stability(Stable) @NotNull public Object getCapacity()
      The connector's compute capacity settings.
    • setCapacity

      @Stability(Stable) public void setCapacity(@NotNull IResolvable value)
      The connector's compute capacity settings.
    • setCapacity

      @Stability(Stable) public void setCapacity(@NotNull CfnConnector.CapacityProperty value)
      The connector's compute capacity settings.
    • getConnectorConfiguration

      @Stability(Stable) @NotNull public Object getConnectorConfiguration()
      The configuration of the connector.
    • setConnectorConfiguration

      @Stability(Stable) public void setConnectorConfiguration(@NotNull IResolvable value)
      The configuration of the connector.
    • setConnectorConfiguration

      @Stability(Stable) public void setConnectorConfiguration(@NotNull Map<String,String> value)
      The configuration of the connector.
    • getConnectorName

      @Stability(Stable) @NotNull public String getConnectorName()
      The name of the connector.
    • setConnectorName

      @Stability(Stable) public void setConnectorName(@NotNull String value)
      The name of the connector.
    • getKafkaCluster

      @Stability(Stable) @NotNull public Object getKafkaCluster()
      The details of the Apache Kafka cluster to which the connector is connected.
    • setKafkaCluster

      @Stability(Stable) public void setKafkaCluster(@NotNull IResolvable value)
      The details of the Apache Kafka cluster to which the connector is connected.
    • setKafkaCluster

      @Stability(Stable) public void setKafkaCluster(@NotNull CfnConnector.KafkaClusterProperty value)
      The details of the Apache Kafka cluster to which the connector is connected.
    • getKafkaClusterClientAuthentication

      @Stability(Stable) @NotNull public Object getKafkaClusterClientAuthentication()
      The type of client authentication used to connect to the Apache Kafka cluster.
    • setKafkaClusterClientAuthentication

      @Stability(Stable) public void setKafkaClusterClientAuthentication(@NotNull IResolvable value)
      The type of client authentication used to connect to the Apache Kafka cluster.
    • setKafkaClusterClientAuthentication

      @Stability(Stable) public void setKafkaClusterClientAuthentication(@NotNull CfnConnector.KafkaClusterClientAuthenticationProperty value)
      The type of client authentication used to connect to the Apache Kafka cluster.
    • getKafkaClusterEncryptionInTransit

      @Stability(Stable) @NotNull public Object getKafkaClusterEncryptionInTransit()
      Details of encryption in transit to the Apache Kafka cluster.
    • setKafkaClusterEncryptionInTransit

      @Stability(Stable) public void setKafkaClusterEncryptionInTransit(@NotNull IResolvable value)
      Details of encryption in transit to the Apache Kafka cluster.
    • setKafkaClusterEncryptionInTransit

      @Stability(Stable) public void setKafkaClusterEncryptionInTransit(@NotNull CfnConnector.KafkaClusterEncryptionInTransitProperty value)
      Details of encryption in transit to the Apache Kafka cluster.
    • getKafkaConnectVersion

      @Stability(Stable) @NotNull public String getKafkaConnectVersion()
      The version of Kafka Connect.
    • setKafkaConnectVersion

      @Stability(Stable) public void setKafkaConnectVersion(@NotNull String value)
      The version of Kafka Connect.
    • getPlugins

      @Stability(Stable) @NotNull public Object getPlugins()
      Specifies which plugin to use for the connector.
    • setPlugins

      @Stability(Stable) public void setPlugins(@NotNull IResolvable value)
      Specifies which plugin to use for the connector.
    • setPlugins

      @Stability(Stable) public void setPlugins(@NotNull List<Object> value)
      Specifies which plugin to use for the connector.
    • getServiceExecutionRoleArn

      @Stability(Stable) @NotNull public String getServiceExecutionRoleArn()
      The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
    • setServiceExecutionRoleArn

      @Stability(Stable) public void setServiceExecutionRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
    • getConnectorDescription

      @Stability(Stable) @Nullable public String getConnectorDescription()
      The description of the connector.
    • setConnectorDescription

      @Stability(Stable) public void setConnectorDescription(@Nullable String value)
      The description of the connector.
    • getLogDelivery

      @Stability(Stable) @Nullable public Object getLogDelivery()
      The settings for delivering connector logs to Amazon CloudWatch Logs.
    • setLogDelivery

      @Stability(Stable) public void setLogDelivery(@Nullable IResolvable value)
      The settings for delivering connector logs to Amazon CloudWatch Logs.
    • setLogDelivery

      @Stability(Stable) public void setLogDelivery(@Nullable CfnConnector.LogDeliveryProperty value)
      The settings for delivering connector logs to Amazon CloudWatch Logs.
    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A collection of tags associated with a resource.
    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A collection of tags associated with a resource.
    • getWorkerConfiguration

      @Stability(Stable) @Nullable public Object getWorkerConfiguration()
      The worker configurations that are in use with the connector.
    • setWorkerConfiguration

      @Stability(Stable) public void setWorkerConfiguration(@Nullable IResolvable value)
      The worker configurations that are in use with the connector.
    • setWorkerConfiguration

      @Stability(Stable) public void setWorkerConfiguration(@Nullable CfnConnector.WorkerConfigurationProperty value)
      The worker configurations that are in use with the connector.