Package software.amazon.awscdk.services.kafkaconnect

Class CfnConnector

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.kafkaconnect.CfnConnector

All Implemented Interfaces:

IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:03.390Z")
@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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnConnector.ApacheKafkaClusterProperty	The details of the Apache Kafka cluster to which the connector is connected.
static interface	CfnConnector.AutoScalingProperty	Specifies how the connector scales.
static final class	CfnConnector.Builder	A fluent builder for CfnConnector.
static interface	CfnConnector.CapacityProperty	Information about the capacity of the connector, whether it is auto scaled or provisioned.
static interface	CfnConnector.CloudWatchLogsLogDeliveryProperty	The settings for delivering connector logs to Amazon CloudWatch Logs.
static interface	CfnConnector.CustomPluginProperty	A plugin is an AWS resource that contains the code that defines a connector's logic.
static interface	CfnConnector.FirehoseLogDeliveryProperty	The settings for delivering logs to Amazon Kinesis Data Firehose.
static interface	CfnConnector.KafkaClusterClientAuthenticationProperty	The client authentication information used in order to authenticate with the Apache Kafka cluster.
static interface	CfnConnector.KafkaClusterEncryptionInTransitProperty	Details of encryption in transit to the Apache Kafka cluster.
static interface	CfnConnector.KafkaClusterProperty	The details of the Apache Kafka cluster to which the connector is connected.
static interface	CfnConnector.LogDeliveryProperty	Details about log delivery.
static interface	CfnConnector.PluginProperty	A plugin is an AWS resource that contains the code that defines your connector logic.
static interface	CfnConnector.ProvisionedCapacityProperty	Details about a connector's provisioned capacity.
static interface	CfnConnector.S3LogDeliveryProperty	Details about delivering logs to Amazon S3.
static interface	CfnConnector.ScaleInPolicyProperty	The scale-in policy for the connector.
static interface	CfnConnector.ScaleOutPolicyProperty	The scale-out policy for the connector.
static interface	CfnConnector.VpcProperty	Information about the VPC in which the connector resides.
static interface	CfnConnector.WorkerConfigurationProperty	The configuration of the workers, which are the processes that run the connector logic.
static interface	CfnConnector.WorkerLogDeliveryProperty	Workers can send worker logs to different destination types.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnConnector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnector(software.amazon.jsii.JsiiObjectRef objRef)
	CfnConnector(software.constructs.Construct scope, String id, CfnConnectorProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrConnectorArn()	The Amazon Resource Name (ARN) of the newly created connector.
Object	getCapacity()	The connector's compute capacity settings.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
Object	getConnectorConfiguration()	The configuration of the connector.
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.
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.
List<CfnTag>	getTags()	A collection of tags associated with a resource.
Object	getWorkerConfiguration()	The worker configurations that are in use with the connector.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCapacity(IResolvable value)	The connector's compute capacity settings.
void	setCapacity(CfnConnector.CapacityProperty value)	The connector's compute capacity settings.
void	setConnectorConfiguration(Map<String,String> value)	The configuration of the connector.
void	setConnectorConfiguration(IResolvable value)	The configuration of the connector.
void	setConnectorDescription(String value)	The description of the connector.
void	setConnectorName(String value)	The name of the connector.
void	setKafkaCluster(IResolvable value)	The details of the Apache Kafka cluster to which the connector is connected.
void	setKafkaCluster(CfnConnector.KafkaClusterProperty value)	The details of the Apache Kafka cluster to which the connector is connected.
void	setKafkaClusterClientAuthentication(IResolvable value)	The type of client authentication used to connect to the Apache Kafka cluster.
void	setKafkaClusterClientAuthentication(CfnConnector.KafkaClusterClientAuthenticationProperty value)	The type of client authentication used to connect to the Apache Kafka cluster.
void	setKafkaClusterEncryptionInTransit(IResolvable value)	Details of encryption in transit to the Apache Kafka cluster.
void	setKafkaClusterEncryptionInTransit(CfnConnector.KafkaClusterEncryptionInTransitProperty value)	Details of encryption in transit to the Apache Kafka cluster.
void	setKafkaConnectVersion(String value)	The version of Kafka Connect.
void	setLogDelivery(IResolvable value)	The settings for delivering connector logs to Amazon CloudWatch Logs.
void	setLogDelivery(CfnConnector.LogDeliveryProperty value)	The settings for delivering connector logs to Amazon CloudWatch Logs.
void	setPlugins(List<Object> value)	Specifies which plugin to use for the connector.
void	setPlugins(IResolvable value)	Specifies which plugin to use for the connector.
void	setServiceExecutionRoleArn(String value)	The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
void	setTags(List<CfnTag> value)	A collection of tags associated with a resource.
void	setWorkerConfiguration(IResolvable value)	The worker configurations that are in use with the connector.
void	setWorkerConfiguration(CfnConnector.WorkerConfigurationProperty value)	The worker configurations that are in use with the connector.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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.