@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:37.169Z") public class CfnConnector extends CfnResource implements IInspectable
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()) .workerConfiguration(WorkerConfigurationProperty.builder() .revision(123) .workerConfigurationArn("workerConfigurationArn") .build()) .build();
Modifier and Type | Class and 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 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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnConnector(Construct scope,
java.lang.String id,
CfnConnectorProps props)
Create a new `AWS::KafkaConnect::Connector`.
|
protected |
CfnConnector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnConnector(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrConnectorArn()
The Amazon Resource Name (ARN) of the newly created connector.
|
java.lang.Object |
getCapacity()
The connector's compute capacity settings.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getConnectorConfiguration()
The configuration of the connector.
|
java.lang.String |
getConnectorDescription()
The description of the connector.
|
java.lang.String |
getConnectorName()
The name of the connector.
|
java.lang.Object |
getKafkaCluster()
The details of the Apache Kafka cluster to which the connector is connected.
|
java.lang.Object |
getKafkaClusterClientAuthentication()
The type of client authentication used to connect to the Apache Kafka cluster.
|
java.lang.Object |
getKafkaClusterEncryptionInTransit()
Details of encryption in transit to the Apache Kafka cluster.
|
java.lang.String |
getKafkaConnectVersion()
The version of Kafka Connect.
|
java.lang.Object |
getLogDelivery()
The settings for delivering connector logs to Amazon CloudWatch Logs.
|
java.lang.Object |
getPlugins()
Specifies which plugin to use for the connector.
|
java.lang.String |
getServiceExecutionRoleArn()
The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
|
java.lang.Object |
getWorkerConfiguration()
The worker configurations that are in use with the connector.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setCapacity(CfnConnector.CapacityProperty value)
The connector's compute capacity settings.
|
void |
setCapacity(IResolvable value)
The connector's compute capacity settings.
|
void |
setConnectorConfiguration(IResolvable value)
The configuration of the connector.
|
void |
setConnectorConfiguration(java.util.Map<java.lang.String,java.lang.String> value)
The configuration of the connector.
|
void |
setConnectorDescription(java.lang.String value)
The description of the connector.
|
void |
setConnectorName(java.lang.String value)
The name of the connector.
|
void |
setKafkaCluster(CfnConnector.KafkaClusterProperty value)
The details of the Apache Kafka cluster to which the connector is connected.
|
void |
setKafkaCluster(IResolvable value)
The details of the Apache Kafka cluster to which the connector is connected.
|
void |
setKafkaClusterClientAuthentication(CfnConnector.KafkaClusterClientAuthenticationProperty value)
The type of client authentication used to connect to the Apache Kafka cluster.
|
void |
setKafkaClusterClientAuthentication(IResolvable value)
The type of client authentication used to connect to the Apache Kafka cluster.
|
void |
setKafkaClusterEncryptionInTransit(CfnConnector.KafkaClusterEncryptionInTransitProperty value)
Details of encryption in transit to the Apache Kafka cluster.
|
void |
setKafkaClusterEncryptionInTransit(IResolvable value)
Details of encryption in transit to the Apache Kafka cluster.
|
void |
setKafkaConnectVersion(java.lang.String value)
The version of Kafka Connect.
|
void |
setLogDelivery(CfnConnector.LogDeliveryProperty value)
The settings for delivering connector logs to Amazon CloudWatch Logs.
|
void |
setLogDelivery(IResolvable value)
The settings for delivering connector logs to Amazon CloudWatch Logs.
|
void |
setPlugins(IResolvable value)
Specifies which plugin to use for the connector.
|
void |
setPlugins(java.util.List<java.lang.Object> value)
Specifies which plugin to use for the connector.
|
void |
setServiceExecutionRoleArn(java.lang.String value)
The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
|
void |
setWorkerConfiguration(CfnConnector.WorkerConfigurationProperty value)
The worker configurations that are in use with the connector.
|
void |
setWorkerConfiguration(IResolvable value)
The worker configurations that are in use with the connector.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnConnector(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnConnector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnConnector(Construct scope, java.lang.String id, CfnConnectorProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrConnectorArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.Object getCapacity()
public void setCapacity(CfnConnector.CapacityProperty value)
public void setCapacity(IResolvable value)
public java.lang.Object getConnectorConfiguration()
public void setConnectorConfiguration(IResolvable value)
public void setConnectorConfiguration(java.util.Map<java.lang.String,java.lang.String> value)
public java.lang.String getConnectorName()
public void setConnectorName(java.lang.String value)
public java.lang.Object getKafkaCluster()
public void setKafkaCluster(IResolvable value)
public void setKafkaCluster(CfnConnector.KafkaClusterProperty value)
public java.lang.Object getKafkaClusterClientAuthentication()
The value is NONE when no client authentication is used.
public void setKafkaClusterClientAuthentication(IResolvable value)
The value is NONE when no client authentication is used.
public void setKafkaClusterClientAuthentication(CfnConnector.KafkaClusterClientAuthenticationProperty value)
The value is NONE when no client authentication is used.
public java.lang.Object getKafkaClusterEncryptionInTransit()
public void setKafkaClusterEncryptionInTransit(IResolvable value)
public void setKafkaClusterEncryptionInTransit(CfnConnector.KafkaClusterEncryptionInTransitProperty value)
public java.lang.String getKafkaConnectVersion()
It has to be compatible with both the Apache Kafka cluster's version and the plugins.
public void setKafkaConnectVersion(java.lang.String value)
It has to be compatible with both the Apache Kafka cluster's version and the plugins.
public java.lang.Object getPlugins()
You must specify a single-element list. Amazon MSK Connect does not currently support specifying multiple plugins.
public void setPlugins(IResolvable value)
You must specify a single-element list. Amazon MSK Connect does not currently support specifying multiple plugins.
public void setPlugins(java.util.List<java.lang.Object> value)
You must specify a single-element list. Amazon MSK Connect does not currently support specifying multiple plugins.
public java.lang.String getServiceExecutionRoleArn()
public void setServiceExecutionRoleArn(java.lang.String value)
public java.lang.String getConnectorDescription()
public void setConnectorDescription(java.lang.String value)
public java.lang.Object getLogDelivery()
public void setLogDelivery(IResolvable value)
public void setLogDelivery(CfnConnector.LogDeliveryProperty value)
public java.lang.Object getWorkerConfiguration()
public void setWorkerConfiguration(IResolvable value)
public void setWorkerConfiguration(CfnConnector.WorkerConfigurationProperty value)