CreateCustomPluginCommand

Creates a custom plugin using the specified properties.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { KafkaConnectClient, CreateCustomPluginCommand } from "@aws-sdk/client-kafkaconnect"; // ES Modules import
// const { KafkaConnectClient, CreateCustomPluginCommand } = require("@aws-sdk/client-kafkaconnect"); // CommonJS import
const client = new KafkaConnectClient(config);
const input = { // CreateCustomPluginRequest
  contentType: "STRING_VALUE", // required
  description: "STRING_VALUE",
  location: { // CustomPluginLocation
    s3Location: { // S3Location
      bucketArn: "STRING_VALUE", // required
      fileKey: "STRING_VALUE", // required
      objectVersion: "STRING_VALUE",
    },
  },
  name: "STRING_VALUE", // required
  tags: { // Tags
    "<keys>": "STRING_VALUE",
  },
};
const command = new CreateCustomPluginCommand(input);
const response = await client.send(command);
// { // CreateCustomPluginResponse
//   customPluginArn: "STRING_VALUE",
//   customPluginState: "STRING_VALUE",
//   name: "STRING_VALUE",
//   revision: Number("long"),
// };

CreateCustomPluginCommand Input

See CreateCustomPluginCommandInput for more details

Parameter
Type
Description
contentType
Required
CustomPluginContentType | undefined

The type of the plugin file.

location
Required
CustomPluginLocation | undefined

Information about the location of a custom plugin.

name
Required
string | undefined

The name of the custom plugin.

description
string | undefined

A summary description of the custom plugin.

tags
Record<string, string> | undefined

The tags you want to attach to the custom plugin.

CreateCustomPluginCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
customPluginArn
string | undefined

The Amazon Resource Name (ARN) that Amazon assigned to the custom plugin.

customPluginState
CustomPluginState | undefined

The state of the custom plugin.

name
string | undefined

The name of the custom plugin.

revision
number | undefined

The revision of the custom plugin.

Throws

Name
Fault
Details
BadRequestException
client

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

ConflictException
client

HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your request with another name.

ForbiddenException
client

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

InternalServerErrorException
server

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

NotFoundException
client

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

ServiceUnavailableException
server

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

TooManyRequestsException
client

HTTP Status Code 429: Limit exceeded. Resource limit reached.

UnauthorizedException
client

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

KafkaConnectServiceException
Base exception class for all service exceptions from KafkaConnect service.