Skip to content

Resource: awsMskconnectCustomPlugin

Provides an Amazon MSK Connect Custom Plugin Resource.

Example Usage

Basic configuration

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
const awsS3BucketExample = new aws.s3Bucket.S3Bucket(this, "example", {
  bucket: "example",
});
const awsS3ObjectExample = new aws.s3Object.S3Object(this, "example_1", {
  bucket: awsS3BucketExample.id,
  key: "debezium.zip",
  source: "debezium.zip",
});
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
awsS3ObjectExample.overrideLogicalId("example");
const awsMskconnectCustomPluginExample =
  new aws.mskconnectCustomPlugin.MskconnectCustomPlugin(this, "example_2", {
    contentType: "ZIP",
    location: {
      s3: {
        bucketArn: awsS3BucketExample.arn,
        fileKey: awsS3ObjectExample.key,
      },
    },
    name: "debezium-example",
  });
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
awsMskconnectCustomPluginExample.overrideLogicalId("example");

Argument Reference

The following arguments are required:

  • name - (Required) The name of the custom plugin..
  • contentType - (Required) The type of the plugin file. Allowed values are zip and jar.
  • location - (Required) Information about the location of a custom plugin. See below.

The following arguments are optional:

  • description - (Optional) A summary description of the custom plugin.

location Argument Reference

  • s3 - (Required) Information of the plugin file stored in Amazon S3. See below.

location s3 Argument Reference

  • bucketArn - (Required) The Amazon Resource Name (ARN) of an S3 bucket.
  • fileKey - (Required) The file key for an object in an S3 bucket.
  • objectVersion - (Optional) The version of an object in an S3 bucket.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • arn - the Amazon Resource Name (ARN) of the custom plugin.
  • latestRevision - an ID of the latest successfully created revision of the custom plugin.
  • state - the state of the custom plugin.

Timeouts

Configuration options:

  • create - (Default 10M)
  • delete - (Default 10M)

Import

MSK Connect Custom Plugin can be imported using the plugin's arn, e.g.,

$ terraform import aws_mskconnect_custom_plugin.example 'arn:aws:kafkaconnect:eu-central-1:123456789012:custom-plugin/debezium-example/abcdefgh-1234-5678-9abc-defghijklmno-4'