@pulumi/gcp

import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Description * * ## Example Usage * * ### Apihub Plugin Instance Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const apihubPluginInstanceBasic = new gcp.apihub.PluginInstance("apihub_plugin_instance_basic", { * location: "us-central1", * plugin: "existing-plugin-id", * pluginInstanceId: "test", * displayName: "Sample Plugin Instance Display Name", * disable: false, * actions: [{ * actionId: "existing-action-id", * }], * }); * ``` * * ## Import * * PluginInstance can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/plugins/{{plugin}}/instances/{{plugin_instance_id}}` * * * `{{project}}/{{location}}/{{plugin}}/{{plugin_instance_id}}` * * * `{{location}}/{{plugin}}/{{plugin_instance_id}}` * * When using the `pulumi import` command, PluginInstance can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:apihub/pluginInstance:PluginInstance default projects/{{project}}/locations/{{location}}/plugins/{{plugin}}/instances/{{plugin_instance_id}} * ``` * * ```sh * $ pulumi import gcp:apihub/pluginInstance:PluginInstance default {{project}}/{{location}}/{{plugin}}/{{plugin_instance_id}} * ``` * * ```sh * $ pulumi import gcp:apihub/pluginInstance:PluginInstance default {{location}}/{{plugin}}/{{plugin_instance_id}} * ``` */ export declare class PluginInstance extends pulumi.CustomResource { /** * Get an existing PluginInstance 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?: PluginInstanceState, opts?: pulumi.CustomResourceOptions): PluginInstance; /** * Returns true if the given object is an instance of PluginInstance. 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 PluginInstance; /** * The action status for the plugin instance. * Structure is documented below. */ readonly actions: pulumi.Output<outputs.apihub.PluginInstanceAction[]>; /** * AuthConfig represents the authentication information. * Structure is documented below. */ readonly authConfig: pulumi.Output<outputs.apihub.PluginInstanceAuthConfig | undefined>; /** * Timestamp indicating when the plugin instance was created. */ readonly createTime: pulumi.Output<string>; /** * The display name for this plugin instance. Max length is 255 characters. */ readonly disable: pulumi.Output<boolean | undefined>; /** * The display name for this plugin instance. Max length is 255 characters. */ readonly displayName: pulumi.Output<string>; /** * Error message describing the failure, if any, during Create, Delete or * ApplyConfig operation corresponding to the plugin instance.This field will * only be populated if the plugin instance is in the ERROR or FAILED state. */ readonly errorMessage: pulumi.Output<string>; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ readonly location: pulumi.Output<string>; /** * Identifier. The unique name of the plugin instance resource. * Format: * `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` */ readonly name: pulumi.Output<string>; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ readonly plugin: pulumi.Output<string>; /** * The ID to use for the plugin instance, which will become the final * component of the plugin instance's resource name. This field is optional. * * If provided, the same will be used. The service will throw an error if * the specified id is already used by another plugin instance in the plugin * resource. * * If not provided, a system generated id will be used. * This value should be 4-63 characters, and valid characters * are /a-z[0-9]-_/. */ readonly pluginInstanceId: pulumi.Output<string>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output<string>; /** * The current state of the plugin instance (e.g., enabled, disabled, * provisioning). * Possible values: * STATE_UNSPECIFIED * CREATING * ACTIVE * APPLYING_CONFIG * ERROR * FAILED * DELETING */ readonly state: pulumi.Output<string>; /** * Timestamp indicating when the plugin instance was last updated. */ readonly updateTime: pulumi.Output<string>; /** * Create a PluginInstance 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: PluginInstanceArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering PluginInstance resources. */ export interface PluginInstanceState { /** * The action status for the plugin instance. * Structure is documented below. */ actions?: pulumi.Input<pulumi.Input<inputs.apihub.PluginInstanceAction>[]>; /** * AuthConfig represents the authentication information. * Structure is documented below. */ authConfig?: pulumi.Input<inputs.apihub.PluginInstanceAuthConfig>; /** * Timestamp indicating when the plugin instance was created. */ createTime?: pulumi.Input<string>; /** * The display name for this plugin instance. Max length is 255 characters. */ disable?: pulumi.Input<boolean>; /** * The display name for this plugin instance. Max length is 255 characters. */ displayName?: pulumi.Input<string>; /** * Error message describing the failure, if any, during Create, Delete or * ApplyConfig operation corresponding to the plugin instance.This field will * only be populated if the plugin instance is in the ERROR or FAILED state. */ errorMessage?: pulumi.Input<string>; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ location?: pulumi.Input<string>; /** * Identifier. The unique name of the plugin instance resource. * Format: * `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` */ name?: pulumi.Input<string>; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ plugin?: pulumi.Input<string>; /** * The ID to use for the plugin instance, which will become the final * component of the plugin instance's resource name. This field is optional. * * If provided, the same will be used. The service will throw an error if * the specified id is already used by another plugin instance in the plugin * resource. * * If not provided, a system generated id will be used. * This value should be 4-63 characters, and valid characters * are /a-z[0-9]-_/. */ pluginInstanceId?: pulumi.Input<string>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input<string>; /** * The current state of the plugin instance (e.g., enabled, disabled, * provisioning). * Possible values: * STATE_UNSPECIFIED * CREATING * ACTIVE * APPLYING_CONFIG * ERROR * FAILED * DELETING */ state?: pulumi.Input<string>; /** * Timestamp indicating when the plugin instance was last updated. */ updateTime?: pulumi.Input<string>; } /** * The set of arguments for constructing a PluginInstance resource. */ export interface PluginInstanceArgs { /** * The action status for the plugin instance. * Structure is documented below. */ actions?: pulumi.Input<pulumi.Input<inputs.apihub.PluginInstanceAction>[]>; /** * AuthConfig represents the authentication information. * Structure is documented below. */ authConfig?: pulumi.Input<inputs.apihub.PluginInstanceAuthConfig>; /** * The display name for this plugin instance. Max length is 255 characters. */ disable?: pulumi.Input<boolean>; /** * The display name for this plugin instance. Max length is 255 characters. */ displayName: pulumi.Input<string>; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ location: pulumi.Input<string>; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ plugin: pulumi.Input<string>; /** * The ID to use for the plugin instance, which will become the final * component of the plugin instance's resource name. This field is optional. * * If provided, the same will be used. The service will throw an error if * the specified id is already used by another plugin instance in the plugin * resource. * * If not provided, a system generated id will be used. * This value should be 4-63 characters, and valid characters * are /a-z[0-9]-_/. */ pluginInstanceId: pulumi.Input<string>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input<string>; }