Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. kafkaconnect
  5. CustomPlugin

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.kafkaconnect.CustomPlugin

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
pulumi/pulumi-aws-native

    An example resource schema demonstrating some basic constructs and validation rules.

    Create CustomPlugin Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CustomPlugin(name: string, args: CustomPluginArgs, opts?: CustomResourceOptions);
    @overload
def CustomPlugin(resource_name: str,
                 args: CustomPluginArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def CustomPlugin(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 content_type: Optional[CustomPluginContentType] = None,
                 location: Optional[CustomPluginLocationArgs] = None,
                 description: Optional[str] = None,
                 name: Optional[str] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewCustomPlugin(ctx *Context, name string, args CustomPluginArgs, opts ...ResourceOption) (*CustomPlugin, error)
    public CustomPlugin(string name, CustomPluginArgs args, CustomResourceOptions? opts = null)
    public CustomPlugin(String name, CustomPluginArgs args)
public CustomPlugin(String name, CustomPluginArgs args, CustomResourceOptions options)

    type: aws-native:kafkaconnect:CustomPlugin
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CustomPluginArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CustomPluginArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CustomPluginArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomPluginArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomPluginArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const customPluginResource = new aws_native.kafkaconnect.CustomPlugin("customPluginResource", {
    contentType: aws_native.kafkaconnect.CustomPluginContentType.Jar,
    location: {
        s3Location: {
            bucketArn: "string",
            fileKey: "string",
            objectVersion: "string",
        },
    },
    description: "string",
    name: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
});

    Coming soon!

    CustomPlugin Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The CustomPlugin resource accepts the following input properties:

    ContentType Pulumi.AwsNative.KafkaConnect.CustomPluginContentType
    The type of the plugin file.
    Location Pulumi.AwsNative.KafkaConnect.Inputs.CustomPluginLocation
    Description string
    A summary description of the custom plugin.
    Name string
    The name of the custom plugin.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    ContentType CustomPluginContentType
    The type of the plugin file.
    Location CustomPluginLocationArgs
    Description string
    A summary description of the custom plugin.
    Name string
    The name of the custom plugin.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    contentType CustomPluginContentType
    The type of the plugin file.
    location CustomPluginLocation
    description String
    A summary description of the custom plugin.
    name String
    The name of the custom plugin.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    contentType CustomPluginContentType
    The type of the plugin file.
    location CustomPluginLocation
    description string
    A summary description of the custom plugin.
    name string
    The name of the custom plugin.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    content_type CustomPluginContentType
    The type of the plugin file.
    location CustomPluginLocationArgs
    description str
    A summary description of the custom plugin.
    name str
    The name of the custom plugin.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    contentType "JAR" | "ZIP"
    The type of the plugin file.
    location Property Map
    description String
    A summary description of the custom plugin.
    name String
    The name of the custom plugin.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CustomPlugin resource produces the following output properties:

    CustomPluginArn string
    The Amazon Resource Name (ARN) of the custom plugin to use.
    FileDescription Pulumi.AwsNative.KafkaConnect.Outputs.CustomPluginFileDescription
    Id string
    The provider-assigned unique ID for this managed resource.
    Revision int
    The revision of the custom plugin.
    CustomPluginArn string
    The Amazon Resource Name (ARN) of the custom plugin to use.
    FileDescription CustomPluginFileDescription
    Id string
    The provider-assigned unique ID for this managed resource.
    Revision int
    The revision of the custom plugin.
    customPluginArn String
    The Amazon Resource Name (ARN) of the custom plugin to use.
    fileDescription CustomPluginFileDescription
    id String
    The provider-assigned unique ID for this managed resource.
    revision Integer
    The revision of the custom plugin.
    customPluginArn string
    The Amazon Resource Name (ARN) of the custom plugin to use.
    fileDescription CustomPluginFileDescription
    id string
    The provider-assigned unique ID for this managed resource.
    revision number
    The revision of the custom plugin.
    custom_plugin_arn str
    The Amazon Resource Name (ARN) of the custom plugin to use.
    file_description CustomPluginFileDescription
    id str
    The provider-assigned unique ID for this managed resource.
    revision int
    The revision of the custom plugin.
    customPluginArn String
    The Amazon Resource Name (ARN) of the custom plugin to use.
    fileDescription Property Map
    id String
    The provider-assigned unique ID for this managed resource.
    revision Number
    The revision of the custom plugin.

    Supporting Types

    CustomPluginContentType, CustomPluginContentTypeArgs

    Jar
    JAR
    Zip
    ZIP
    CustomPluginContentTypeJar
    JAR
    CustomPluginContentTypeZip
    ZIP
    Jar
    JAR
    Zip
    ZIP
    Jar
    JAR
    Zip
    ZIP
    JAR
    JAR
    ZIP
    ZIP
    "JAR"
    JAR
    "ZIP"
    ZIP

    CustomPluginFileDescription, CustomPluginFileDescriptionArgs

    FileMd5 string
    The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.
    FileSize int
    The size in bytes of the custom plugin file. You can use it to validate the file.
    FileMd5 string
    The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.
    FileSize int
    The size in bytes of the custom plugin file. You can use it to validate the file.
    fileMd5 String
    The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.
    fileSize Integer
    The size in bytes of the custom plugin file. You can use it to validate the file.
    fileMd5 string
    The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.
    fileSize number
    The size in bytes of the custom plugin file. You can use it to validate the file.
    file_md5 str
    The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.
    file_size int
    The size in bytes of the custom plugin file. You can use it to validate the file.
    fileMd5 String
    The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.
    fileSize Number
    The size in bytes of the custom plugin file. You can use it to validate the file.

    CustomPluginLocation, CustomPluginLocationArgs

    CustomPluginS3Location, CustomPluginS3LocationArgs

    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.
    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.
    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.
    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.
    bucket_arn str
    The Amazon Resource Name (ARN) of an S3 bucket.
    file_key str
    The file key for an object in an S3 bucket.
    object_version str
    The version of an object in an S3 bucket.
    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.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
    pulumi/pulumi-aws-native