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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-04-22T22:36:23.160Z")
 @Stability(value=Stable)
public class CfnConnector
extends CfnResource
implements IInspectable

A CloudFormation `AWS::KafkaConnect::Connector`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnConnector.ApacheKafkaClusterProperty Example:
static interface	CfnConnector.AutoScalingProperty Example:
static class	CfnConnector.Builder A fluent builder for CfnConnector.
static interface	CfnConnector.CapacityProperty Example:
static interface	CfnConnector.CloudWatchLogsLogDeliveryProperty Example:
static interface	CfnConnector.CustomPluginProperty Example:
static interface	CfnConnector.FirehoseLogDeliveryProperty Example:
static interface	CfnConnector.KafkaClusterClientAuthenticationProperty Example:
static interface	CfnConnector.KafkaClusterEncryptionInTransitProperty Example:
static interface	CfnConnector.KafkaClusterProperty Example:
static interface	CfnConnector.LogDeliveryProperty Example:
static interface	CfnConnector.PluginProperty Example:
static interface	CfnConnector.ProvisionedCapacityProperty Example:
static interface	CfnConnector.S3LogDeliveryProperty Example:
static interface	CfnConnector.ScaleInPolicyProperty Example:
static interface	CfnConnector.ScaleOutPolicyProperty Example:
static interface	CfnConnector.VpcProperty Example:
static interface	CfnConnector.WorkerConfigurationProperty Example:
static interface	CfnConnector.WorkerLogDeliveryProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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)

Method Summary

Modifier and Type	Method and Description
String	getAttrConnectorArn()
Object	getCapacity() `AWS::KafkaConnect::Connector.Capacity`.
protected Map<String,Object>	getCfnProperties()
Object	getConnectorConfiguration() `AWS::KafkaConnect::Connector.ConnectorConfiguration`.
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`.
Object	getLogDelivery() `AWS::KafkaConnect::Connector.LogDelivery`.
Object	getPlugins() `AWS::KafkaConnect::Connector.Plugins`.
String	getServiceExecutionRoleArn() `AWS::KafkaConnect::Connector.ServiceExecutionRoleArn`.
Object	getWorkerConfiguration() `AWS::KafkaConnect::Connector.WorkerConfiguration`.
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) `AWS::KafkaConnect::Connector.Capacity`.
void	setCapacity(IResolvable value) `AWS::KafkaConnect::Connector.Capacity`.
void	setConnectorConfiguration(IResolvable value) `AWS::KafkaConnect::Connector.ConnectorConfiguration`.
void	setConnectorConfiguration(Map<String,String> value) `AWS::KafkaConnect::Connector.ConnectorConfiguration`.
void	setConnectorDescription(String value) `AWS::KafkaConnect::Connector.ConnectorDescription`.
void	setConnectorName(String value) `AWS::KafkaConnect::Connector.ConnectorName`.
void	setKafkaCluster(CfnConnector.KafkaClusterProperty value) `AWS::KafkaConnect::Connector.KafkaCluster`.
void	setKafkaCluster(IResolvable value) `AWS::KafkaConnect::Connector.KafkaCluster`.
void	setKafkaClusterClientAuthentication(CfnConnector.KafkaClusterClientAuthenticationProperty value) `AWS::KafkaConnect::Connector.KafkaClusterClientAuthentication`.
void	setKafkaClusterClientAuthentication(IResolvable value) `AWS::KafkaConnect::Connector.KafkaClusterClientAuthentication`.
void	setKafkaClusterEncryptionInTransit(CfnConnector.KafkaClusterEncryptionInTransitProperty value) `AWS::KafkaConnect::Connector.KafkaClusterEncryptionInTransit`.
void	setKafkaClusterEncryptionInTransit(IResolvable value) `AWS::KafkaConnect::Connector.KafkaClusterEncryptionInTransit`.
void	setKafkaConnectVersion(String value) `AWS::KafkaConnect::Connector.KafkaConnectVersion`.
void	setLogDelivery(CfnConnector.LogDeliveryProperty value) `AWS::KafkaConnect::Connector.LogDelivery`.
void	setLogDelivery(IResolvable value) `AWS::KafkaConnect::Connector.LogDelivery`.
void	setPlugins(IResolvable value) `AWS::KafkaConnect::Connector.Plugins`.
void	setPlugins(List<Object> value) `AWS::KafkaConnect::Connector.Plugins`.
void	setServiceExecutionRoleArn(String value) `AWS::KafkaConnect::Connector.ServiceExecutionRoleArn`.
void	setWorkerConfiguration(CfnConnector.WorkerConfigurationProperty value) `AWS::KafkaConnect::Connector.WorkerConfiguration`.
void	setWorkerConfiguration(IResolvable value) `AWS::KafkaConnect::Connector.WorkerConfiguration`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnConnector

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

CfnConnector

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

CfnConnector

@Stability(value=Stable)
public CfnConnector(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             CfnConnectorProps props)

Create a new `AWS::KafkaConnect::Connector`.

Parameters:

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.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrConnectorArn()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCapacity

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

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

setCapacity

@Stability(value=Stable)
public void setCapacity(@NotNull
                                                 CfnConnector.CapacityProperty value)

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

setCapacity

@Stability(value=Stable)
public void setCapacity(@NotNull
                                                 IResolvable value)

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

getConnectorConfiguration

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

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

setConnectorConfiguration

@Stability(value=Stable)
public void setConnectorConfiguration(@NotNull
                                                               IResolvable value)

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

setConnectorConfiguration

@Stability(value=Stable)
public void setConnectorConfiguration(@NotNull
                                                               Map<String,String> value)

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

getConnectorName

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

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

setConnectorName

@Stability(value=Stable)
public void setConnectorName(@NotNull
                                                      String value)

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

getKafkaCluster

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

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

setKafkaCluster

@Stability(value=Stable)
public void setKafkaCluster(@NotNull
                                                     CfnConnector.KafkaClusterProperty value)

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

setKafkaCluster

@Stability(value=Stable)
public void setKafkaCluster(@NotNull
                                                     IResolvable value)

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

getKafkaClusterClientAuthentication

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

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

setKafkaClusterClientAuthentication

@Stability(value=Stable)
public void setKafkaClusterClientAuthentication(@NotNull
                                                                         CfnConnector.KafkaClusterClientAuthenticationProperty value)

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

setKafkaClusterClientAuthentication

@Stability(value=Stable)
public void setKafkaClusterClientAuthentication(@NotNull
                                                                         IResolvable value)

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

getKafkaClusterEncryptionInTransit

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

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

setKafkaClusterEncryptionInTransit

@Stability(value=Stable)
public void setKafkaClusterEncryptionInTransit(@NotNull
                                                                        CfnConnector.KafkaClusterEncryptionInTransitProperty value)

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

setKafkaClusterEncryptionInTransit

@Stability(value=Stable)
public void setKafkaClusterEncryptionInTransit(@NotNull
                                                                        IResolvable value)

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

getKafkaConnectVersion

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

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

setKafkaConnectVersion

@Stability(value=Stable)
public void setKafkaConnectVersion(@NotNull
                                                            String value)

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

getPlugins

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

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

setPlugins

@Stability(value=Stable)
public void setPlugins(@NotNull
                                                IResolvable value)

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

setPlugins

@Stability(value=Stable)
public void setPlugins(@NotNull
                                                List<Object> value)

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

getServiceExecutionRoleArn

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

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

setServiceExecutionRoleArn

@Stability(value=Stable)
public void setServiceExecutionRoleArn(@NotNull
                                                                String value)

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

getConnectorDescription

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

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

setConnectorDescription

@Stability(value=Stable)
public void setConnectorDescription(@Nullable
                                                             String value)

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

getLogDelivery

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

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

setLogDelivery

@Stability(value=Stable)
public void setLogDelivery(@Nullable
                                                    CfnConnector.LogDeliveryProperty value)

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

setLogDelivery

@Stability(value=Stable)
public void setLogDelivery(@Nullable
                                                    IResolvable value)

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

getWorkerConfiguration

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

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

setWorkerConfiguration

@Stability(value=Stable)
public void setWorkerConfiguration(@Nullable
                                                            CfnConnector.WorkerConfigurationProperty value)

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

setWorkerConfiguration

@Stability(value=Stable)
public void setWorkerConfiguration(@Nullable
                                                            IResolvable value)

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