MSK Connect

3 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

KafkaConnectConnector # CLOUD CONTROL · AWS::KafkaConnect::Connector

KafkaConnectConnector manages AWS::KafkaConnect::Connector through the AWS Cloud Control API.

kubectl get kafkaconnectconnectors · example on GitHub

Example

# KafkaConnectConnector — MSK Connect
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/kafkaconnect.html#kafkaconnectconnector
apiVersion: aws.konfig.io/v1alpha1
kind: KafkaConnectConnector
metadata:
  name: example-kafkaconnectconnector
  namespace: default
spec:
  capacity:
    autoScaling:
      maxAutoscalingTaskCount: 2
      maxWorkerCount: 2
      mcuCount: 2
      minWorkerCount: 2
      scaleInPolicy:
        cpuUtilizationPercentage: 1
      scaleOutPolicy:
        cpuUtilizationPercentage: 1
    provisionedCapacity:
      mcuCount: 2
      workerCount: 2
  connectorConfiguration:
    key: value
  connectorDescription: Managed by konfig-konector
  connectorName: example-kafkaconnectconnector
  kafkaCluster:
    apacheKafkaCluster:
      bootstrapServers: example
      vpc:
        securityGroups:
        - example
        subnets:
        - example
  kafkaClusterClientAuthentication:
    authenticationType: NONE
  kafkaClusterEncryptionInTransit:
    encryptionType: PLAINTEXT
  kafkaConnectVersion: '1.0'
  logDelivery:
    workerLogDelivery:
      cloudWatchLogs:
        enabled: true
        logGroup: example
      firehose:
        deliveryStream: example
        enabled: true
      s3:
        bucket: example
        enabled: true
        prefix: example
  networkType: IPV4
  plugins:
  - customPlugin:
      customPluginArn: arn:aws:iam::123456789012:role/example-role
      revision: 1
  providerRef:
    name: example-kafkaconnectconnector
    region: us-east-1
  serviceExecutionRoleArn: arn:aws:iam::123456789012:role/example-role
  tags:
  - key: example
    value: example
  workerConfiguration:
    revision: 1
    workerConfigurationArn: arn:aws:iam::123456789012:role/example-role

Spec

Field	Type	Required	Description
`capacity`	object	yes	KafkaConnectConnectorCapacity is a nested property type of AWS::KafkaConnect::Connector.
`capacity.autoScaling`	object	—	KafkaConnectConnectorAutoScaling is a nested property type of AWS::KafkaConnect::Connector.
`capacity.autoScaling.maxAutoscalingTaskCount`	integer	—	The maximum number of tasks allocated to the connector during autoscaling operations.
`capacity.autoScaling.maxWorkerCount`	integer	yes	The maximum number of workers for a connector.
`capacity.autoScaling.mcuCount`	integer	yes	Specifies how many MSK Connect Units (MCU) as the minimum scaling unit.
`capacity.autoScaling.minWorkerCount`	integer	yes	The minimum number of workers for a connector.
`capacity.autoScaling.scaleInPolicy`	object	yes	KafkaConnectConnectorScaleInPolicy is a nested property type of AWS::KafkaConnect::Connector.
`capacity.autoScaling.scaleInPolicy.cpuUtilizationPercentage`	integer	yes	Specifies the CPU utilization percentage threshold at which connector scale in should trigger.
`capacity.autoScaling.scaleOutPolicy`	object	yes	KafkaConnectConnectorScaleOutPolicy is a nested property type of AWS::KafkaConnect::Connector.
`capacity.autoScaling.scaleOutPolicy.cpuUtilizationPercentage`	integer	yes	Specifies the CPU utilization percentage threshold at which connector scale out should trigger.
`capacity.provisionedCapacity`	object	—	KafkaConnectConnectorProvisionedCapacity is a nested property type of AWS::KafkaConnect::Connector.
`capacity.provisionedCapacity.mcuCount`	integer	yes	Specifies how many MSK Connect Units (MCU) are allocated to the connector.
`capacity.provisionedCapacity.workerCount`	integer	yes	Number of workers for a connector.
`connectorConfiguration`	map<string>	yes	The configuration for the connector.
`connectorDescription`	string	—	A summary description of the connector.
`connectorName`	string	yes	The name of the connector.
`kafkaCluster`	object	yes	Create-only in AWS: changing it requires replacing the resource.
`kafkaCluster.apacheKafkaCluster`	object	yes	KafkaConnectConnectorApacheKafkaCluster is a nested property type of AWS::KafkaConnect::Connector.
`kafkaCluster.apacheKafkaCluster.bootstrapServers`	string	yes	The bootstrap servers string of the Apache Kafka cluster.
`kafkaCluster.apacheKafkaCluster.vpc`	object	yes	KafkaConnectConnectorVpc is a nested property type of AWS::KafkaConnect::Connector.
`kafkaCluster.apacheKafkaCluster.vpc.securityGroups`	array<string>	yes	The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to.
`kafkaCluster.apacheKafkaCluster.vpc.subnets`	array<string>	yes	The list of subnets to connect to in the virtual private cloud (VPC).
`kafkaClusterClientAuthentication`	object	yes	Create-only in AWS: changing it requires replacing the resource.
`kafkaClusterClientAuthentication.authenticationType`	enum	yes	Allowed: `NONE, IAM`
`kafkaClusterEncryptionInTransit`	object	yes	Create-only in AWS: changing it requires replacing the resource.
`kafkaClusterEncryptionInTransit.encryptionType`	enum	yes	Allowed: `PLAINTEXT, TLS`
`kafkaConnectVersion`	string	yes	The version of Kafka Connect.
`logDelivery`	object	—	Create-only in AWS: changing it requires replacing the resource.
`logDelivery.workerLogDelivery`	object	yes	KafkaConnectConnectorWorkerLogDelivery is a nested property type of AWS::KafkaConnect::Connector.
`logDelivery.workerLogDelivery.cloudWatchLogs`	object	—	KafkaConnectConnectorCloudWatchLogsLogDelivery is a nested property type of AWS::KafkaConnect::Connector.
`logDelivery.workerLogDelivery.cloudWatchLogs.enabled`	boolean	yes	Specifies whether the logs get sent to the specified CloudWatch Logs destination.
`logDelivery.workerLogDelivery.cloudWatchLogs.logGroup`	string	—	The CloudWatch log group that is the destination for log delivery.
`logDelivery.workerLogDelivery.firehose`	object	—	KafkaConnectConnectorFirehoseLogDelivery is a nested property type of AWS::KafkaConnect::Connector.
`logDelivery.workerLogDelivery.firehose.deliveryStream`	string	—	The Kinesis Data Firehose delivery stream that is the destination for log delivery.
`logDelivery.workerLogDelivery.firehose.enabled`	boolean	yes	Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream.
`logDelivery.workerLogDelivery.s3`	object	—	KafkaConnectConnectorS3LogDelivery is a nested property type of AWS::KafkaConnect::Connector.
`logDelivery.workerLogDelivery.s3.bucket`	string	—	The name of the S3 bucket that is the destination for log delivery.
`logDelivery.workerLogDelivery.s3.enabled`	boolean	yes	Specifies whether the logs get sent to the specified Amazon S3 destination.
`logDelivery.workerLogDelivery.s3.prefix`	string	—	The S3 prefix that is the destination for log delivery.
`networkType`	enum	—	The network type of the Connector. Allowed: `IPV4, DUAL`
`plugins`	array<object>	yes	List of plugins to use with the connector.
`plugins[].customPlugin`	object	yes	KafkaConnectConnectorCustomPlugin is a nested property type of AWS::KafkaConnect::Connector.
`plugins[].customPlugin.customPluginArn`	string	yes	The Amazon Resource Name (ARN) of the custom plugin to use.
`plugins[].customPlugin.revision`	integer	yes	The revision of the custom plugin to use.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`serviceExecutionRoleArn`	string	yes	The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.
`tags`	array<object>	—	A collection of tags associated with a resource
`tags[].key`	string	yes
`tags[].value`	string	yes
`workerConfiguration`	object	—	Create-only in AWS: changing it requires replacing the resource.
`workerConfiguration.revision`	integer	yes	The revision of the worker configuration to use.
`workerConfiguration.workerConfigurationArn`	string	yes	The Amazon Resource Name (ARN) of the worker configuration to use.

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`connectorArn`	string	—	Amazon Resource Name for the created Connector.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

KafkaConnectCustomPlugin # CLOUD CONTROL · AWS::KafkaConnect::CustomPlugin

KafkaConnectCustomPlugin manages AWS::KafkaConnect::CustomPlugin through the AWS Cloud Control API.

kubectl get kafkaconnectcustomplugins · example on GitHub

Example

# KafkaConnectCustomPlugin — MSK Connect
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/kafkaconnect.html#kafkaconnectcustomplugin
apiVersion: aws.konfig.io/v1alpha1
kind: KafkaConnectCustomPlugin
metadata:
  name: example-kafkaconnectcustomplugin
  namespace: default
spec:
  contentType: JAR
  description: Managed by konfig-konector
  location:
    s3Location:
      bucketArn: arn:aws:iam::123456789012:role/example-role
      fileKey: example
      objectVersion: '1.0'
  name: example-kafkaconnectcustomplugin
  providerRef:
    name: example-kafkaconnectcustomplugin
    region: us-east-1
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`contentType`	enum	yes	The type of the plugin file. Allowed: `JAR, ZIP`
`description`	string	—	A summary description of the custom plugin.
`location`	object	yes	Create-only in AWS: changing it requires replacing the resource.
`location.s3Location`	object	yes	KafkaConnectCustomPluginS3Location is a nested property type of AWS::KafkaConnect::CustomPlugin.
`location.s3Location.bucketArn`	string	yes	The Amazon Resource Name (ARN) of an S3 bucket.
`location.s3Location.fileKey`	string	yes	The file key for an object in an S3 bucket.
`location.s3Location.objectVersion`	string	—	The version of an object in an S3 bucket.
`name`	string	yes	The name of the custom plugin.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`customPluginArn`	string	—	The Amazon Resource Name (ARN) of the custom plugin to use.
`fileDescription`	object	—	Read-only: reported by AWS after creation.
`fileDescription.fileMd5`	string	—	The hex-encoded MD5 checksum of the custom plugin file.
`fileDescription.fileSize`	integer	—	The size in bytes of the custom plugin file.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.
`revision`	integer	—	The revision of the custom plugin.

KafkaConnectWorkerConfiguration # CLOUD CONTROL · AWS::KafkaConnect::WorkerConfiguration

KafkaConnectWorkerConfiguration manages AWS::KafkaConnect::WorkerConfiguration through the AWS Cloud Control API.

kubectl get kafkaconnectworkerconfigurations · example on GitHub

Example

# KafkaConnectWorkerConfiguration — MSK Connect
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/kafkaconnect.html#kafkaconnectworkerconfiguration
apiVersion: aws.konfig.io/v1alpha1
kind: KafkaConnectWorkerConfiguration
metadata:
  name: example-kafkaconnectworkerconfiguration
  namespace: default
spec:
  description: Managed by konfig-konector
  name: example-kafkaconnectworkerconfiguration
  propertiesFileContent: example
  providerRef:
    name: example-kafkaconnectworkerconfiguration
    region: us-east-1
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`description`	string	—	A summary description of the worker configuration.
`name`	string	yes	The name of the worker configuration.
`propertiesFileContent`	string	yes	Base64 encoded contents of connect-distributed.properties file.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	array<object>	—	A collection of tags associated with a resource
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.
`revision`	integer	—	The description of a revision of the worker configuration.
`workerConfigurationArn`	string	—	The Amazon Resource Name (ARN) of the custom configuration.