@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:40.116Z") @Stability(value=Stable) 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.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnConnector(software.constructs.Construct scope,
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 |
|---|---|
String |
getAttrConnectorArn()
The Amazon Resource Name (ARN) of the newly created connector.
|
Object |
getCapacity()
The connector's compute capacity settings.
|
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.
|
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(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(Map<String,String> 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(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(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(List<Object> 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 |
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, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnConnector(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnConnector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnConnector(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrConnectorArn()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public Object getCapacity()
@Stability(value=Stable)
public void setCapacity(@NotNull
CfnConnector.CapacityProperty value)
@Stability(value=Stable)
public void setCapacity(@NotNull
IResolvable value)
@Stability(value=Stable) @NotNull public Object getConnectorConfiguration()
@Stability(value=Stable)
public void setConnectorConfiguration(@NotNull
IResolvable value)
@Stability(value=Stable)
public void setConnectorConfiguration(@NotNull
Map<String,String> value)
@Stability(value=Stable) @NotNull public String getConnectorName()
@Stability(value=Stable)
public void setConnectorName(@NotNull
String value)
@Stability(value=Stable) @NotNull public Object getKafkaCluster()
@Stability(value=Stable)
public void setKafkaCluster(@NotNull
CfnConnector.KafkaClusterProperty value)
@Stability(value=Stable)
public void setKafkaCluster(@NotNull
IResolvable value)
@Stability(value=Stable) @NotNull public Object getKafkaClusterClientAuthentication()
The value is NONE when no client authentication is used.
@Stability(value=Stable)
public void setKafkaClusterClientAuthentication(@NotNull
CfnConnector.KafkaClusterClientAuthenticationProperty value)
The value is NONE when no client authentication is used.
@Stability(value=Stable)
public void setKafkaClusterClientAuthentication(@NotNull
IResolvable value)
The value is NONE when no client authentication is used.
@Stability(value=Stable) @NotNull public Object getKafkaClusterEncryptionInTransit()
@Stability(value=Stable)
public void setKafkaClusterEncryptionInTransit(@NotNull
CfnConnector.KafkaClusterEncryptionInTransitProperty value)
@Stability(value=Stable)
public void setKafkaClusterEncryptionInTransit(@NotNull
IResolvable value)
@Stability(value=Stable) @NotNull public String getKafkaConnectVersion()
It has to be compatible with both the Apache Kafka cluster's version and the plugins.
@Stability(value=Stable)
public void setKafkaConnectVersion(@NotNull
String value)
It has to be compatible with both the Apache Kafka cluster's version and the plugins.
@Stability(value=Stable) @NotNull public Object getPlugins()
You must specify a single-element list. Amazon MSK Connect does not currently support specifying multiple plugins.
@Stability(value=Stable)
public void setPlugins(@NotNull
IResolvable value)
You must specify a single-element list. Amazon MSK Connect does not currently support specifying multiple plugins.
@Stability(value=Stable)
public void setPlugins(@NotNull
List<Object> value)
You must specify a single-element list. Amazon MSK Connect does not currently support specifying multiple plugins.
@Stability(value=Stable) @NotNull public String getServiceExecutionRoleArn()
@Stability(value=Stable)
public void setServiceExecutionRoleArn(@NotNull
String value)
@Stability(value=Stable) @Nullable public String getConnectorDescription()
@Stability(value=Stable)
public void setConnectorDescription(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getLogDelivery()
@Stability(value=Stable)
public void setLogDelivery(@Nullable
CfnConnector.LogDeliveryProperty value)
@Stability(value=Stable)
public void setLogDelivery(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getWorkerConfiguration()
@Stability(value=Stable)
public void setWorkerConfiguration(@Nullable
CfnConnector.WorkerConfigurationProperty value)
@Stability(value=Stable)
public void setWorkerConfiguration(@Nullable
IResolvable value)
Copyright © 2022. All rights reserved.