Package software.amazon.awscdk.services.kafkaconnect

Class CfnCustomPlugin

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.kafkaconnect.CfnCustomPlugin
All Implemented Interfaces:
IInspectable, ITaggableV2, ICustomPluginRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:40.623Z") @Stability(Stable) public class CfnCustomPlugin extends CfnResource implements IInspectable, ICustomPluginRef, ITaggableV2
Creates a custom plugin using the specified properties.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kafkaconnect.*;
 CfnCustomPlugin cfnCustomPlugin = CfnCustomPlugin.Builder.create(this, "MyCfnCustomPlugin")
         .contentType("contentType")
         .location(CustomPluginLocationProperty.builder()
                 .s3Location(S3LocationProperty.builder()
                         .bucketArn("bucketArn")
                         .fileKey("fileKey")
                         // the properties below are optional
                         .objectVersion("objectVersion")
                         .build())
                 .build())
         .name("name")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCustomPlugin

      protected CfnCustomPlugin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCustomPlugin

      protected CfnCustomPlugin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCustomPlugin

      @Stability(Stable) public CfnCustomPlugin(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCustomPluginProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCustomPluginArn

      @Stability(Stable) @NotNull public String getAttrCustomPluginArn()
      The Amazon Resource Name (ARN) of the custom plugin.

    • getAttrFileDescription

      @Stability(Stable) @NotNull public IResolvable getAttrFileDescription()
      Details about the custom plugin file.

    • getAttrRevision

      @Stability(Stable) @NotNull public Number getAttrRevision()
      The revision of the custom plugin.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCustomPluginRef

      @Stability(Stable) @NotNull public CustomPluginReference getCustomPluginRef()
      A reference to a CustomPlugin resource.
      Specified by:
      getCustomPluginRef in interface ICustomPluginRef

    • getContentType

      @Stability(Stable) @NotNull public String getContentType()
      The format of the plugin file.

    • setContentType

      @Stability(Stable) public void setContentType(@NotNull String value)
      The format of the plugin file.

    • getLocation

      @Stability(Stable) @NotNull public Object getLocation()
      Information about the location of the custom plugin.

      Returns union: either IResolvable or CfnCustomPlugin.CustomPluginLocationProperty

    • setLocation

      @Stability(Stable) public void setLocation(@NotNull IResolvable value)
      Information about the location of the custom plugin.

    • setLocation

      @Stability(Stable) public void setLocation(@NotNull CfnCustomPlugin.CustomPluginLocationProperty value)
      Information about the location of the custom plugin.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the custom plugin.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the custom plugin.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the custom plugin.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the custom plugin.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.