@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
190 lines (189 loc) • 7.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides an Amazon MSK Connect Custom Plugin Resource.
*
* ## Example Usage
*
* ### Basic configuration
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.s3.Bucket("example", {bucket: "example"});
* const exampleBucketObjectv2 = new aws.s3.BucketObjectv2("example", {
* bucket: example.id,
* key: "debezium.zip",
* source: new pulumi.asset.FileAsset("debezium.zip"),
* });
* const exampleCustomPlugin = new aws.mskconnect.CustomPlugin("example", {
* name: "debezium-example",
* contentType: "ZIP",
* location: {
* s3: {
* bucketArn: example.arn,
* fileKey: exampleBucketObjectv2.key,
* },
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import MSK Connect Custom Plugin using the plugin's `arn`. For example:
*
* ```sh
* $ pulumi import aws:mskconnect/customPlugin:CustomPlugin example 'arn:aws:kafkaconnect:eu-central-1:123456789012:custom-plugin/debezium-example/abcdefgh-1234-5678-9abc-defghijklmno-4'
* ```
*/
export declare class CustomPlugin extends pulumi.CustomResource {
/**
* Get an existing CustomPlugin resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CustomPluginState, opts?: pulumi.CustomResourceOptions): CustomPlugin;
/**
* Returns true if the given object is an instance of CustomPlugin. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is CustomPlugin;
/**
* the Amazon Resource Name (ARN) of the custom plugin.
*/
readonly arn: pulumi.Output<string>;
/**
* The type of the plugin file. Allowed values are `ZIP` and `JAR`.
*/
readonly contentType: pulumi.Output<string>;
/**
* A summary description of the custom plugin.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* an ID of the latest successfully created revision of the custom plugin.
*/
readonly latestRevision: pulumi.Output<number>;
/**
* Information about the location of a custom plugin. See `location` Block for details.
*/
readonly location: pulumi.Output<outputs.mskconnect.CustomPluginLocation>;
/**
* The name of the custom plugin..
*/
readonly name: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* the state of the custom plugin.
*/
readonly state: pulumi.Output<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a CustomPlugin resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: CustomPluginArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CustomPlugin resources.
*/
export interface CustomPluginState {
/**
* the Amazon Resource Name (ARN) of the custom plugin.
*/
arn?: pulumi.Input<string>;
/**
* The type of the plugin file. Allowed values are `ZIP` and `JAR`.
*/
contentType?: pulumi.Input<string>;
/**
* A summary description of the custom plugin.
*/
description?: pulumi.Input<string>;
/**
* an ID of the latest successfully created revision of the custom plugin.
*/
latestRevision?: pulumi.Input<number>;
/**
* Information about the location of a custom plugin. See `location` Block for details.
*/
location?: pulumi.Input<inputs.mskconnect.CustomPluginLocation>;
/**
* The name of the custom plugin..
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* the state of the custom plugin.
*/
state?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a CustomPlugin resource.
*/
export interface CustomPluginArgs {
/**
* The type of the plugin file. Allowed values are `ZIP` and `JAR`.
*/
contentType: pulumi.Input<string>;
/**
* A summary description of the custom plugin.
*/
description?: pulumi.Input<string>;
/**
* Information about the location of a custom plugin. See `location` Block for details.
*/
location: pulumi.Input<inputs.mskconnect.CustomPluginLocation>;
/**
* The name of the custom plugin..
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}