Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . kafkaconnect ]

create-custom-plugin

Description

Creates a custom plugin using the specified properties.

See also: AWS API Documentation

Synopsis

  create-custom-plugin
--content-type <value>
[--description <value>]
--location <value>
--name <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--content-type (string)

The type of the plugin file.

Possible values:

• JAR
• ZIP

--description (string)

A summary description of the custom plugin.

--location (structure)

Information about the location of a custom plugin.

s3Location -> (structure)

The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.

bucketArn -> (string)

The Amazon Resource Name (ARN) of an S3 bucket.

fileKey -> (string)

The file key for an object in an S3 bucket.

objectVersion -> (string)

The version of an object in an S3 bucket.

Shorthand Syntax:

s3Location={bucketArn=string,fileKey=string,objectVersion=string}

JSON Syntax:

{
  "s3Location": {
    "bucketArn": "string",
    "fileKey": "string",
    "objectVersion": "string"
  }
}

--name (string)

The name of the custom plugin.

--tags (map)

The tags you want to attach to the custom plugin.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

customPluginArn -> (string)

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

customPluginState -> (string)

The state of the custom plugin.

name -> (string)

The name of the custom plugin.

revision -> (long)

The revision of the custom plugin.