This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::KafkaConnect::CustomPlugin
<a name="aws-resource-kafkaconnect-customplugin"></a>

Creates a custom plugin using the specified properties.

## Syntax
<a name="aws-resource-kafkaconnect-customplugin-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-kafkaconnect-customplugin-syntax.json"></a>

```
{
  "Type" : "AWS::KafkaConnect::CustomPlugin",
  "Properties" : {
      "[ContentType](#cfn-kafkaconnect-customplugin-contenttype)" : String,
      "[Description](#cfn-kafkaconnect-customplugin-description)" : String,
      "[Location](#cfn-kafkaconnect-customplugin-location)" : CustomPluginLocation,
      "[Name](#cfn-kafkaconnect-customplugin-name)" : String,
      "[Tags](#cfn-kafkaconnect-customplugin-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-kafkaconnect-customplugin-syntax.yaml"></a>

```
Type: AWS::KafkaConnect::CustomPlugin
Properties:
  [ContentType](#cfn-kafkaconnect-customplugin-contenttype): String
  [Description](#cfn-kafkaconnect-customplugin-description): String
  [Location](#cfn-kafkaconnect-customplugin-location): 
    CustomPluginLocation
  [Name](#cfn-kafkaconnect-customplugin-name): String
  [Tags](#cfn-kafkaconnect-customplugin-tags): 
    - Tag
```

## Properties
<a name="aws-resource-kafkaconnect-customplugin-properties"></a>

`ContentType`  <a name="cfn-kafkaconnect-customplugin-contenttype"></a>
The format of the plugin file.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `JAR | ZIP`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Description`  <a name="cfn-kafkaconnect-customplugin-description"></a>
The description of the custom plugin.  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Location`  <a name="cfn-kafkaconnect-customplugin-location"></a>
Information about the location of the custom plugin.  
*Required*: Yes  
*Type*: [CustomPluginLocation](aws-properties-kafkaconnect-customplugin-custompluginlocation.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-kafkaconnect-customplugin-name"></a>
The name of the custom plugin.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-kafkaconnect-customplugin-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-kafkaconnect-customplugin-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-kafkaconnect-customplugin-return-values"></a>

### Ref
<a name="aws-resource-kafkaconnect-customplugin-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-kafkaconnect-customplugin-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-kafkaconnect-customplugin-return-values-fn--getatt-fn--getatt"></a>

`CustomPluginArn`  <a name="CustomPluginArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the custom plugin.

`Revision`  <a name="Revision-fn::getatt"></a>
The revision of the custom plugin.

# AWS::KafkaConnect::CustomPlugin CustomPluginFileDescription
<a name="aws-properties-kafkaconnect-customplugin-custompluginfiledescription"></a>

Details about a custom plugin file.

## Syntax
<a name="aws-properties-kafkaconnect-customplugin-custompluginfiledescription-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kafkaconnect-customplugin-custompluginfiledescription-syntax.json"></a>

```
{
  "[FileMd5](#cfn-kafkaconnect-customplugin-custompluginfiledescription-filemd5)" : String,
  "[FileSize](#cfn-kafkaconnect-customplugin-custompluginfiledescription-filesize)" : Integer
}
```

### YAML
<a name="aws-properties-kafkaconnect-customplugin-custompluginfiledescription-syntax.yaml"></a>

```
  [FileMd5](#cfn-kafkaconnect-customplugin-custompluginfiledescription-filemd5): String
  [FileSize](#cfn-kafkaconnect-customplugin-custompluginfiledescription-filesize): Integer
```

## Properties
<a name="aws-properties-kafkaconnect-customplugin-custompluginfiledescription-properties"></a>

`FileMd5`  <a name="cfn-kafkaconnect-customplugin-custompluginfiledescription-filemd5"></a>
The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FileSize`  <a name="cfn-kafkaconnect-customplugin-custompluginfiledescription-filesize"></a>
The size in bytes of the custom plugin file. You can use it to validate the file.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KafkaConnect::CustomPlugin CustomPluginLocation
<a name="aws-properties-kafkaconnect-customplugin-custompluginlocation"></a>

Information about the location of a custom plugin.

## Syntax
<a name="aws-properties-kafkaconnect-customplugin-custompluginlocation-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kafkaconnect-customplugin-custompluginlocation-syntax.json"></a>

```
{
  "[S3Location](#cfn-kafkaconnect-customplugin-custompluginlocation-s3location)" : S3Location
}
```

### YAML
<a name="aws-properties-kafkaconnect-customplugin-custompluginlocation-syntax.yaml"></a>

```
  [S3Location](#cfn-kafkaconnect-customplugin-custompluginlocation-s3location): 
    S3Location
```

## Properties
<a name="aws-properties-kafkaconnect-customplugin-custompluginlocation-properties"></a>

`S3Location`  <a name="cfn-kafkaconnect-customplugin-custompluginlocation-s3location"></a>
The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.  
*Required*: Yes  
*Type*: [S3Location](aws-properties-kafkaconnect-customplugin-s3location.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KafkaConnect::CustomPlugin S3Location
<a name="aws-properties-kafkaconnect-customplugin-s3location"></a>

The location of an object in Amazon S3.

## Syntax
<a name="aws-properties-kafkaconnect-customplugin-s3location-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kafkaconnect-customplugin-s3location-syntax.json"></a>

```
{
  "[BucketArn](#cfn-kafkaconnect-customplugin-s3location-bucketarn)" : String,
  "[FileKey](#cfn-kafkaconnect-customplugin-s3location-filekey)" : String,
  "[ObjectVersion](#cfn-kafkaconnect-customplugin-s3location-objectversion)" : String
}
```

### YAML
<a name="aws-properties-kafkaconnect-customplugin-s3location-syntax.yaml"></a>

```
  [BucketArn](#cfn-kafkaconnect-customplugin-s3location-bucketarn): String
  [FileKey](#cfn-kafkaconnect-customplugin-s3location-filekey): String
  [ObjectVersion](#cfn-kafkaconnect-customplugin-s3location-objectversion): String
```

## Properties
<a name="aws-properties-kafkaconnect-customplugin-s3location-properties"></a>

`BucketArn`  <a name="cfn-kafkaconnect-customplugin-s3location-bucketarn"></a>
The Amazon Resource Name (ARN) of an S3 bucket.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`FileKey`  <a name="cfn-kafkaconnect-customplugin-s3location-filekey"></a>
The file key for an object in an S3 bucket.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ObjectVersion`  <a name="cfn-kafkaconnect-customplugin-s3location-objectversion"></a>
The version of an object in an S3 bucket.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KafkaConnect::CustomPlugin Tag
<a name="aws-properties-kafkaconnect-customplugin-tag"></a>

<a name="aws-properties-kafkaconnect-customplugin-tag-description"></a>The `Tag` property type specifies Property description not available. for an [AWS::KafkaConnect::CustomPlugin](aws-resource-kafkaconnect-customplugin.md).

## Syntax
<a name="aws-properties-kafkaconnect-customplugin-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kafkaconnect-customplugin-tag-syntax.json"></a>

```
{
  "[Key](#cfn-kafkaconnect-customplugin-tag-key)" : String,
  "[Value](#cfn-kafkaconnect-customplugin-tag-value)" : String
}
```

### YAML
<a name="aws-properties-kafkaconnect-customplugin-tag-syntax.yaml"></a>

```
  [Key](#cfn-kafkaconnect-customplugin-tag-key): String
  [Value](#cfn-kafkaconnect-customplugin-tag-value): String
```

## Properties
<a name="aws-properties-kafkaconnect-customplugin-tag-properties"></a>

`Key`  <a name="cfn-kafkaconnect-customplugin-tag-key"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-kafkaconnect-customplugin-tag-value"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)