Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. apihub
  5. PluginInstance
Google Cloud v8.37.0 published on Monday, Jul 7, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.apihub.PluginInstance

Explore with Pulumi AI

gcp logo
Google Cloud v8.37.0 published on Monday, Jul 7, 2025 by Pulumi
pulumi/pulumi-gcp

    Description

    Example Usage

    Apihub Plugin Instance Basic

    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 pulumi
import pulumi_gcp as gcp

apihub_plugin_instance_basic = gcp.apihub.PluginInstance("apihub_plugin_instance_basic",
    location="us-central1",
    plugin="existing-plugin-id",
    plugin_instance_id="test",
    display_name="Sample Plugin Instance Display Name",
    disable=False,
    actions=[{
        "action_id": "existing-action-id",
    }])

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apihub"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apihub.NewPluginInstance(ctx, "apihub_plugin_instance_basic", &apihub.PluginInstanceArgs{
			Location:         pulumi.String("us-central1"),
			Plugin:           pulumi.String("existing-plugin-id"),
			PluginInstanceId: pulumi.String("test"),
			DisplayName:      pulumi.String("Sample Plugin Instance Display Name"),
			Disable:          pulumi.Bool(false),
			Actions: apihub.PluginInstanceActionArray{
				&apihub.PluginInstanceActionArgs{
					ActionId: pulumi.String("existing-action-id"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var apihubPluginInstanceBasic = new Gcp.ApiHub.PluginInstance("apihub_plugin_instance_basic", new()
    {
        Location = "us-central1",
        Plugin = "existing-plugin-id",
        PluginInstanceId = "test",
        DisplayName = "Sample Plugin Instance Display Name",
        Disable = false,
        Actions = new[]
        {
            new Gcp.ApiHub.Inputs.PluginInstanceActionArgs
            {
                ActionId = "existing-action-id",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.apihub.PluginInstance;
import com.pulumi.gcp.apihub.PluginInstanceArgs;
import com.pulumi.gcp.apihub.inputs.PluginInstanceActionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var apihubPluginInstanceBasic = new PluginInstance("apihubPluginInstanceBasic", PluginInstanceArgs.builder()
            .location("us-central1")
            .plugin("existing-plugin-id")
            .pluginInstanceId("test")
            .displayName("Sample Plugin Instance Display Name")
            .disable(false)
            .actions(PluginInstanceActionArgs.builder()
                .actionId("existing-action-id")
                .build())
            .build());

    }
}

    resources:
  apihubPluginInstanceBasic:
    type: gcp:apihub:PluginInstance
    name: apihub_plugin_instance_basic
    properties:
      location: us-central1
      plugin: existing-plugin-id
      pluginInstanceId: test
      displayName: Sample Plugin Instance Display Name
      disable: false
      actions:
        - actionId: existing-action-id

    Create PluginInstance Resource

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

    Constructor syntax

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

@overload
def PluginInstance(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   display_name: Optional[str] = None,
                   location: Optional[str] = None,
                   plugin: Optional[str] = None,
                   plugin_instance_id: Optional[str] = None,
                   actions: Optional[Sequence[PluginInstanceActionArgs]] = None,
                   auth_config: Optional[PluginInstanceAuthConfigArgs] = None,
                   disable: Optional[bool] = None,
                   project: Optional[str] = None)
    func NewPluginInstance(ctx *Context, name string, args PluginInstanceArgs, opts ...ResourceOption) (*PluginInstance, error)
    public PluginInstance(string name, PluginInstanceArgs args, CustomResourceOptions? opts = null)
    public PluginInstance(String name, PluginInstanceArgs args)
public PluginInstance(String name, PluginInstanceArgs args, CustomResourceOptions options)

    type: gcp:apihub:PluginInstance
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 PluginInstanceArgs
    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 PluginInstanceArgs
    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 PluginInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PluginInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PluginInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var pluginInstanceResource = new Gcp.ApiHub.PluginInstance("pluginInstanceResource", new()
{
    DisplayName = "string",
    Location = "string",
    Plugin = "string",
    PluginInstanceId = "string",
    Actions = new[]
    {
        new Gcp.ApiHub.Inputs.PluginInstanceActionArgs
        {
            ActionId = "string",
            CurationConfig = new Gcp.ApiHub.Inputs.PluginInstanceActionCurationConfigArgs
            {
                CurationType = "string",
                CustomCuration = new Gcp.ApiHub.Inputs.PluginInstanceActionCurationConfigCustomCurationArgs
                {
                    Curation = "string",
                },
            },
            HubInstanceActions = new[]
            {
                new Gcp.ApiHub.Inputs.PluginInstanceActionHubInstanceActionArgs
                {
                    CurrentExecutionState = "string",
                    LastExecutions = new[]
                    {
                        new Gcp.ApiHub.Inputs.PluginInstanceActionHubInstanceActionLastExecutionArgs
                        {
                            EndTime = "string",
                            ErrorMessage = "string",
                            Result = "string",
                            StartTime = "string",
                        },
                    },
                },
            },
            ScheduleCronExpression = "string",
            ScheduleTimeZone = "string",
            State = "string",
        },
    },
    AuthConfig = new Gcp.ApiHub.Inputs.PluginInstanceAuthConfigArgs
    {
        AuthType = "string",
        ApiKeyConfig = new Gcp.ApiHub.Inputs.PluginInstanceAuthConfigApiKeyConfigArgs
        {
            ApiKey = new Gcp.ApiHub.Inputs.PluginInstanceAuthConfigApiKeyConfigApiKeyArgs
            {
                SecretVersion = "string",
            },
            HttpElementLocation = "string",
            Name = "string",
        },
        GoogleServiceAccountConfig = new Gcp.ApiHub.Inputs.PluginInstanceAuthConfigGoogleServiceAccountConfigArgs
        {
            ServiceAccount = "string",
        },
        Oauth2ClientCredentialsConfig = new Gcp.ApiHub.Inputs.PluginInstanceAuthConfigOauth2ClientCredentialsConfigArgs
        {
            ClientId = "string",
            ClientSecret = new Gcp.ApiHub.Inputs.PluginInstanceAuthConfigOauth2ClientCredentialsConfigClientSecretArgs
            {
                SecretVersion = "string",
            },
        },
        UserPasswordConfig = new Gcp.ApiHub.Inputs.PluginInstanceAuthConfigUserPasswordConfigArgs
        {
            Password = new Gcp.ApiHub.Inputs.PluginInstanceAuthConfigUserPasswordConfigPasswordArgs
            {
                SecretVersion = "string",
            },
            Username = "string",
        },
    },
    Disable = false,
    Project = "string",
});

    example, err := apihub.NewPluginInstance(ctx, "pluginInstanceResource", &apihub.PluginInstanceArgs{
	DisplayName:      pulumi.String("string"),
	Location:         pulumi.String("string"),
	Plugin:           pulumi.String("string"),
	PluginInstanceId: pulumi.String("string"),
	Actions: apihub.PluginInstanceActionArray{
		&apihub.PluginInstanceActionArgs{
			ActionId: pulumi.String("string"),
			CurationConfig: &apihub.PluginInstanceActionCurationConfigArgs{
				CurationType: pulumi.String("string"),
				CustomCuration: &apihub.PluginInstanceActionCurationConfigCustomCurationArgs{
					Curation: pulumi.String("string"),
				},
			},
			HubInstanceActions: apihub.PluginInstanceActionHubInstanceActionArray{
				&apihub.PluginInstanceActionHubInstanceActionArgs{
					CurrentExecutionState: pulumi.String("string"),
					LastExecutions: apihub.PluginInstanceActionHubInstanceActionLastExecutionArray{
						&apihub.PluginInstanceActionHubInstanceActionLastExecutionArgs{
							EndTime:      pulumi.String("string"),
							ErrorMessage: pulumi.String("string"),
							Result:       pulumi.String("string"),
							StartTime:    pulumi.String("string"),
						},
					},
				},
			},
			ScheduleCronExpression: pulumi.String("string"),
			ScheduleTimeZone:       pulumi.String("string"),
			State:                  pulumi.String("string"),
		},
	},
	AuthConfig: &apihub.PluginInstanceAuthConfigArgs{
		AuthType: pulumi.String("string"),
		ApiKeyConfig: &apihub.PluginInstanceAuthConfigApiKeyConfigArgs{
			ApiKey: &apihub.PluginInstanceAuthConfigApiKeyConfigApiKeyArgs{
				SecretVersion: pulumi.String("string"),
			},
			HttpElementLocation: pulumi.String("string"),
			Name:                pulumi.String("string"),
		},
		GoogleServiceAccountConfig: &apihub.PluginInstanceAuthConfigGoogleServiceAccountConfigArgs{
			ServiceAccount: pulumi.String("string"),
		},
		Oauth2ClientCredentialsConfig: &apihub.PluginInstanceAuthConfigOauth2ClientCredentialsConfigArgs{
			ClientId: pulumi.String("string"),
			ClientSecret: &apihub.PluginInstanceAuthConfigOauth2ClientCredentialsConfigClientSecretArgs{
				SecretVersion: pulumi.String("string"),
			},
		},
		UserPasswordConfig: &apihub.PluginInstanceAuthConfigUserPasswordConfigArgs{
			Password: &apihub.PluginInstanceAuthConfigUserPasswordConfigPasswordArgs{
				SecretVersion: pulumi.String("string"),
			},
			Username: pulumi.String("string"),
		},
	},
	Disable: pulumi.Bool(false),
	Project: pulumi.String("string"),
})

    var pluginInstanceResource = new PluginInstance("pluginInstanceResource", PluginInstanceArgs.builder()
    .displayName("string")
    .location("string")
    .plugin("string")
    .pluginInstanceId("string")
    .actions(PluginInstanceActionArgs.builder()
        .actionId("string")
        .curationConfig(PluginInstanceActionCurationConfigArgs.builder()
            .curationType("string")
            .customCuration(PluginInstanceActionCurationConfigCustomCurationArgs.builder()
                .curation("string")
                .build())
            .build())
        .hubInstanceActions(PluginInstanceActionHubInstanceActionArgs.builder()
            .currentExecutionState("string")
            .lastExecutions(PluginInstanceActionHubInstanceActionLastExecutionArgs.builder()
                .endTime("string")
                .errorMessage("string")
                .result("string")
                .startTime("string")
                .build())
            .build())
        .scheduleCronExpression("string")
        .scheduleTimeZone("string")
        .state("string")
        .build())
    .authConfig(PluginInstanceAuthConfigArgs.builder()
        .authType("string")
        .apiKeyConfig(PluginInstanceAuthConfigApiKeyConfigArgs.builder()
            .apiKey(PluginInstanceAuthConfigApiKeyConfigApiKeyArgs.builder()
                .secretVersion("string")
                .build())
            .httpElementLocation("string")
            .name("string")
            .build())
        .googleServiceAccountConfig(PluginInstanceAuthConfigGoogleServiceAccountConfigArgs.builder()
            .serviceAccount("string")
            .build())
        .oauth2ClientCredentialsConfig(PluginInstanceAuthConfigOauth2ClientCredentialsConfigArgs.builder()
            .clientId("string")
            .clientSecret(PluginInstanceAuthConfigOauth2ClientCredentialsConfigClientSecretArgs.builder()
                .secretVersion("string")
                .build())
            .build())
        .userPasswordConfig(PluginInstanceAuthConfigUserPasswordConfigArgs.builder()
            .password(PluginInstanceAuthConfigUserPasswordConfigPasswordArgs.builder()
                .secretVersion("string")
                .build())
            .username("string")
            .build())
        .build())
    .disable(false)
    .project("string")
    .build());

    plugin_instance_resource = gcp.apihub.PluginInstance("pluginInstanceResource",
    display_name="string",
    location="string",
    plugin="string",
    plugin_instance_id="string",
    actions=[{
        "action_id": "string",
        "curation_config": {
            "curation_type": "string",
            "custom_curation": {
                "curation": "string",
            },
        },
        "hub_instance_actions": [{
            "current_execution_state": "string",
            "last_executions": [{
                "end_time": "string",
                "error_message": "string",
                "result": "string",
                "start_time": "string",
            }],
        }],
        "schedule_cron_expression": "string",
        "schedule_time_zone": "string",
        "state": "string",
    }],
    auth_config={
        "auth_type": "string",
        "api_key_config": {
            "api_key": {
                "secret_version": "string",
            },
            "http_element_location": "string",
            "name": "string",
        },
        "google_service_account_config": {
            "service_account": "string",
        },
        "oauth2_client_credentials_config": {
            "client_id": "string",
            "client_secret": {
                "secret_version": "string",
            },
        },
        "user_password_config": {
            "password": {
                "secret_version": "string",
            },
            "username": "string",
        },
    },
    disable=False,
    project="string")

    const pluginInstanceResource = new gcp.apihub.PluginInstance("pluginInstanceResource", {
    displayName: "string",
    location: "string",
    plugin: "string",
    pluginInstanceId: "string",
    actions: [{
        actionId: "string",
        curationConfig: {
            curationType: "string",
            customCuration: {
                curation: "string",
            },
        },
        hubInstanceActions: [{
            currentExecutionState: "string",
            lastExecutions: [{
                endTime: "string",
                errorMessage: "string",
                result: "string",
                startTime: "string",
            }],
        }],
        scheduleCronExpression: "string",
        scheduleTimeZone: "string",
        state: "string",
    }],
    authConfig: {
        authType: "string",
        apiKeyConfig: {
            apiKey: {
                secretVersion: "string",
            },
            httpElementLocation: "string",
            name: "string",
        },
        googleServiceAccountConfig: {
            serviceAccount: "string",
        },
        oauth2ClientCredentialsConfig: {
            clientId: "string",
            clientSecret: {
                secretVersion: "string",
            },
        },
        userPasswordConfig: {
            password: {
                secretVersion: "string",
            },
            username: "string",
        },
    },
    disable: false,
    project: "string",
});

    type: gcp:apihub:PluginInstance
properties:
    actions:
        - actionId: string
          curationConfig:
            curationType: string
            customCuration:
                curation: string
          hubInstanceActions:
            - currentExecutionState: string
              lastExecutions:
                - endTime: string
                  errorMessage: string
                  result: string
                  startTime: string
          scheduleCronExpression: string
          scheduleTimeZone: string
          state: string
    authConfig:
        apiKeyConfig:
            apiKey:
                secretVersion: string
            httpElementLocation: string
            name: string
        authType: string
        googleServiceAccountConfig:
            serviceAccount: string
        oauth2ClientCredentialsConfig:
            clientId: string
            clientSecret:
                secretVersion: string
        userPasswordConfig:
            password:
                secretVersion: string
            username: string
    disable: false
    displayName: string
    location: string
    plugin: string
    pluginInstanceId: string
    project: string

    PluginInstance Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PluginInstance resource accepts the following input properties:

    DisplayName string
    The display name for this plugin instance. Max length is 255 characters.
    Location 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 string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    PluginInstanceId 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]-_/.
    Actions List<PluginInstanceAction>
    The action status for the plugin instance. Structure is documented below.
    AuthConfig PluginInstanceAuthConfig
    AuthConfig represents the authentication information.
    Disable bool
    The display name for this plugin instance. Max length is 255 characters.
    Project string
    DisplayName string
    The display name for this plugin instance. Max length is 255 characters.
    Location 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 string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    PluginInstanceId 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]-_/.
    Actions []PluginInstanceActionArgs
    The action status for the plugin instance. Structure is documented below.
    AuthConfig PluginInstanceAuthConfigArgs
    AuthConfig represents the authentication information.
    Disable bool
    The display name for this plugin instance. Max length is 255 characters.
    Project string
    displayName String
    The display name for this plugin instance. Max length is 255 characters.
    location 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 String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    pluginInstanceId 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]-_/.
    actions List<PluginInstanceAction>
    The action status for the plugin instance. Structure is documented below.
    authConfig PluginInstanceAuthConfig
    AuthConfig represents the authentication information.
    disable Boolean
    The display name for this plugin instance. Max length is 255 characters.
    project String
    displayName string
    The display name for this plugin instance. Max length is 255 characters.
    location 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 string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    pluginInstanceId 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]-_/.
    actions PluginInstanceAction[]
    The action status for the plugin instance. Structure is documented below.
    authConfig PluginInstanceAuthConfig
    AuthConfig represents the authentication information.
    disable boolean
    The display name for this plugin instance. Max length is 255 characters.
    project string
    display_name str
    The display name for this plugin instance. Max length is 255 characters.
    location str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    plugin str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    plugin_instance_id str
    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]-_/.
    actions Sequence[PluginInstanceActionArgs]
    The action status for the plugin instance. Structure is documented below.
    auth_config PluginInstanceAuthConfigArgs
    AuthConfig represents the authentication information.
    disable bool
    The display name for this plugin instance. Max length is 255 characters.
    project str
    displayName String
    The display name for this plugin instance. Max length is 255 characters.
    location 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 String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    pluginInstanceId 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]-_/.
    actions List<Property Map>
    The action status for the plugin instance. Structure is documented below.
    authConfig Property Map
    AuthConfig represents the authentication information.
    disable Boolean
    The display name for this plugin instance. Max length is 255 characters.
    project String

    Outputs

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

    CreateTime string
    Timestamp indicating when the plugin instance was created.
    ErrorMessage 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
    State string
    The current state of the plugin instance (e.g., enabled, disabled, provisioning). Possible values: STATE_UNSPECIFIED CREATING ACTIVE APPLYING_CONFIG ERROR FAILED DELETING
    UpdateTime string
    Timestamp indicating when the plugin instance was last updated.
    CreateTime string
    Timestamp indicating when the plugin instance was created.
    ErrorMessage 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
    State string
    The current state of the plugin instance (e.g., enabled, disabled, provisioning). Possible values: STATE_UNSPECIFIED CREATING ACTIVE APPLYING_CONFIG ERROR FAILED DELETING
    UpdateTime string
    Timestamp indicating when the plugin instance was last updated.
    createTime String
    Timestamp indicating when the plugin instance was created.
    errorMessage 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.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
    state String
    The current state of the plugin instance (e.g., enabled, disabled, provisioning). Possible values: STATE_UNSPECIFIED CREATING ACTIVE APPLYING_CONFIG ERROR FAILED DELETING
    updateTime String
    Timestamp indicating when the plugin instance was last updated.
    createTime string
    Timestamp indicating when the plugin instance was created.
    errorMessage 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.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
    state string
    The current state of the plugin instance (e.g., enabled, disabled, provisioning). Possible values: STATE_UNSPECIFIED CREATING ACTIVE APPLYING_CONFIG ERROR FAILED DELETING
    updateTime string
    Timestamp indicating when the plugin instance was last updated.
    create_time str
    Timestamp indicating when the plugin instance was created.
    error_message str
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
    state str
    The current state of the plugin instance (e.g., enabled, disabled, provisioning). Possible values: STATE_UNSPECIFIED CREATING ACTIVE APPLYING_CONFIG ERROR FAILED DELETING
    update_time str
    Timestamp indicating when the plugin instance was last updated.
    createTime String
    Timestamp indicating when the plugin instance was created.
    errorMessage 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.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
    state String
    The current state of the plugin instance (e.g., enabled, disabled, provisioning). Possible values: STATE_UNSPECIFIED CREATING ACTIVE APPLYING_CONFIG ERROR FAILED DELETING
    updateTime String
    Timestamp indicating when the plugin instance was last updated.

    Look up Existing PluginInstance Resource

    Get an existing PluginInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PluginInstanceState, opts?: CustomResourceOptions): PluginInstance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        actions: Optional[Sequence[PluginInstanceActionArgs]] = None,
        auth_config: Optional[PluginInstanceAuthConfigArgs] = None,
        create_time: Optional[str] = None,
        disable: Optional[bool] = None,
        display_name: Optional[str] = None,
        error_message: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        plugin: Optional[str] = None,
        plugin_instance_id: Optional[str] = None,
        project: Optional[str] = None,
        state: Optional[str] = None,
        update_time: Optional[str] = None) -> PluginInstance
    func GetPluginInstance(ctx *Context, name string, id IDInput, state *PluginInstanceState, opts ...ResourceOption) (*PluginInstance, error)
    public static PluginInstance Get(string name, Input<string> id, PluginInstanceState? state, CustomResourceOptions? opts = null)
    public static PluginInstance get(String name, Output<String> id, PluginInstanceState state, CustomResourceOptions options)
    resources:  _:    type: gcp:apihub:PluginInstance    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Actions List<PluginInstanceAction>
    The action status for the plugin instance. Structure is documented below.
    AuthConfig PluginInstanceAuthConfig
    AuthConfig represents the authentication information.
    CreateTime string
    Timestamp indicating when the plugin instance was created.
    Disable bool
    The display name for this plugin instance. Max length is 255 characters.
    DisplayName string
    The display name for this plugin instance. Max length is 255 characters.
    ErrorMessage 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.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    Name string
    Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
    Plugin string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    PluginInstanceId 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]-_/.
    Project string
    State string
    The current state of the plugin instance (e.g., enabled, disabled, provisioning). Possible values: STATE_UNSPECIFIED CREATING ACTIVE APPLYING_CONFIG ERROR FAILED DELETING
    UpdateTime string
    Timestamp indicating when the plugin instance was last updated.
    Actions []PluginInstanceActionArgs
    The action status for the plugin instance. Structure is documented below.
    AuthConfig PluginInstanceAuthConfigArgs
    AuthConfig represents the authentication information.
    CreateTime string
    Timestamp indicating when the plugin instance was created.
    Disable bool
    The display name for this plugin instance. Max length is 255 characters.
    DisplayName string
    The display name for this plugin instance. Max length is 255 characters.
    ErrorMessage 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.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    Name string
    Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
    Plugin string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    PluginInstanceId 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]-_/.
    Project string
    State string
    The current state of the plugin instance (e.g., enabled, disabled, provisioning). Possible values: STATE_UNSPECIFIED CREATING ACTIVE APPLYING_CONFIG ERROR FAILED DELETING
    UpdateTime string
    Timestamp indicating when the plugin instance was last updated.
    actions List<PluginInstanceAction>
    The action status for the plugin instance. Structure is documented below.
    authConfig PluginInstanceAuthConfig
    AuthConfig represents the authentication information.
    createTime String
    Timestamp indicating when the plugin instance was created.
    disable Boolean
    The display name for this plugin instance. Max length is 255 characters.
    displayName String
    The display name for this plugin instance. Max length is 255 characters.
    errorMessage 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.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    name String
    Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
    plugin String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    pluginInstanceId 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]-_/.
    project String
    state String
    The current state of the plugin instance (e.g., enabled, disabled, provisioning). Possible values: STATE_UNSPECIFIED CREATING ACTIVE APPLYING_CONFIG ERROR FAILED DELETING
    updateTime String
    Timestamp indicating when the plugin instance was last updated.
    actions PluginInstanceAction[]
    The action status for the plugin instance. Structure is documented below.
    authConfig PluginInstanceAuthConfig
    AuthConfig represents the authentication information.
    createTime string
    Timestamp indicating when the plugin instance was created.
    disable boolean
    The display name for this plugin instance. Max length is 255 characters.
    displayName string
    The display name for this plugin instance. Max length is 255 characters.
    errorMessage 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.
    location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    name string
    Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
    plugin string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    pluginInstanceId 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]-_/.
    project string
    state string
    The current state of the plugin instance (e.g., enabled, disabled, provisioning). Possible values: STATE_UNSPECIFIED CREATING ACTIVE APPLYING_CONFIG ERROR FAILED DELETING
    updateTime string
    Timestamp indicating when the plugin instance was last updated.
    actions Sequence[PluginInstanceActionArgs]
    The action status for the plugin instance. Structure is documented below.
    auth_config PluginInstanceAuthConfigArgs
    AuthConfig represents the authentication information.
    create_time str
    Timestamp indicating when the plugin instance was created.
    disable bool
    The display name for this plugin instance. Max length is 255 characters.
    display_name str
    The display name for this plugin instance. Max length is 255 characters.
    error_message str
    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.
    location str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    name str
    Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
    plugin str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    plugin_instance_id str
    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]-_/.
    project str
    state str
    The current state of the plugin instance (e.g., enabled, disabled, provisioning). Possible values: STATE_UNSPECIFIED CREATING ACTIVE APPLYING_CONFIG ERROR FAILED DELETING
    update_time str
    Timestamp indicating when the plugin instance was last updated.
    actions List<Property Map>
    The action status for the plugin instance. Structure is documented below.
    authConfig Property Map
    AuthConfig represents the authentication information.
    createTime String
    Timestamp indicating when the plugin instance was created.
    disable Boolean
    The display name for this plugin instance. Max length is 255 characters.
    displayName String
    The display name for this plugin instance. Max length is 255 characters.
    errorMessage 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.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    name String
    Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
    plugin String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    pluginInstanceId 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]-_/.
    project String
    state String
    The current state of the plugin instance (e.g., enabled, disabled, provisioning). Possible values: STATE_UNSPECIFIED CREATING ACTIVE APPLYING_CONFIG ERROR FAILED DELETING
    updateTime String
    Timestamp indicating when the plugin instance was last updated.

    Supporting Types

    PluginInstanceAction, PluginInstanceActionArgs

    ActionId string
    This should map to one of the action id specified in actions_config in the plugin.
    CurationConfig PluginInstanceActionCurationConfig
    The curation information for this plugin instance. Structure is documented below.
    HubInstanceActions List<PluginInstanceActionHubInstanceAction>
    (Output) The execution status for the plugin instance. Structure is documented below.
    ScheduleCronExpression string
    The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
    ScheduleTimeZone string

    The time zone for the schedule cron expression. If not provided, UTC will be used.

    The hub_instance_action block contains:

    State string
    (Output) The current state of the plugin action in the plugin instance. Possible values: STATE_UNSPECIFIED ENABLED DISABLED ENABLING DISABLING ERROR
    ActionId string
    This should map to one of the action id specified in actions_config in the plugin.
    CurationConfig PluginInstanceActionCurationConfig
    The curation information for this plugin instance. Structure is documented below.
    HubInstanceActions []PluginInstanceActionHubInstanceAction
    (Output) The execution status for the plugin instance. Structure is documented below.
    ScheduleCronExpression string
    The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
    ScheduleTimeZone string

    The time zone for the schedule cron expression. If not provided, UTC will be used.

    The hub_instance_action block contains:

    State string
    (Output) The current state of the plugin action in the plugin instance. Possible values: STATE_UNSPECIFIED ENABLED DISABLED ENABLING DISABLING ERROR
    actionId String
    This should map to one of the action id specified in actions_config in the plugin.
    curationConfig PluginInstanceActionCurationConfig
    The curation information for this plugin instance. Structure is documented below.
    hubInstanceActions List<PluginInstanceActionHubInstanceAction>
    (Output) The execution status for the plugin instance. Structure is documented below.
    scheduleCronExpression String
    The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
    scheduleTimeZone String

    The time zone for the schedule cron expression. If not provided, UTC will be used.

    The hub_instance_action block contains:

    state String
    (Output) The current state of the plugin action in the plugin instance. Possible values: STATE_UNSPECIFIED ENABLED DISABLED ENABLING DISABLING ERROR
    actionId string
    This should map to one of the action id specified in actions_config in the plugin.
    curationConfig PluginInstanceActionCurationConfig
    The curation information for this plugin instance. Structure is documented below.
    hubInstanceActions PluginInstanceActionHubInstanceAction[]
    (Output) The execution status for the plugin instance. Structure is documented below.
    scheduleCronExpression string
    The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
    scheduleTimeZone string

    The time zone for the schedule cron expression. If not provided, UTC will be used.

    The hub_instance_action block contains:

    state string
    (Output) The current state of the plugin action in the plugin instance. Possible values: STATE_UNSPECIFIED ENABLED DISABLED ENABLING DISABLING ERROR
    action_id str
    This should map to one of the action id specified in actions_config in the plugin.
    curation_config PluginInstanceActionCurationConfig
    The curation information for this plugin instance. Structure is documented below.
    hub_instance_actions Sequence[PluginInstanceActionHubInstanceAction]
    (Output) The execution status for the plugin instance. Structure is documented below.
    schedule_cron_expression str
    The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
    schedule_time_zone str

    The time zone for the schedule cron expression. If not provided, UTC will be used.

    The hub_instance_action block contains:

    state str
    (Output) The current state of the plugin action in the plugin instance. Possible values: STATE_UNSPECIFIED ENABLED DISABLED ENABLING DISABLING ERROR
    actionId String
    This should map to one of the action id specified in actions_config in the plugin.
    curationConfig Property Map
    The curation information for this plugin instance. Structure is documented below.
    hubInstanceActions List<Property Map>
    (Output) The execution status for the plugin instance. Structure is documented below.
    scheduleCronExpression String
    The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
    scheduleTimeZone String

    The time zone for the schedule cron expression. If not provided, UTC will be used.

    The hub_instance_action block contains:

    state String
    (Output) The current state of the plugin action in the plugin instance. Possible values: STATE_UNSPECIFIED ENABLED DISABLED ENABLING DISABLING ERROR

    PluginInstanceActionCurationConfig, PluginInstanceActionCurationConfigArgs

    CurationType string
    Possible values: CURATION_TYPE_UNSPECIFIED DEFAULT_CURATION_FOR_API_METADATA CUSTOM_CURATION_FOR_API_METADATA
    CustomCuration PluginInstanceActionCurationConfigCustomCuration
    Custom curation information for this plugin instance. Structure is documented below.
    CurationType string
    Possible values: CURATION_TYPE_UNSPECIFIED DEFAULT_CURATION_FOR_API_METADATA CUSTOM_CURATION_FOR_API_METADATA
    CustomCuration PluginInstanceActionCurationConfigCustomCuration
    Custom curation information for this plugin instance. Structure is documented below.
    curationType String
    Possible values: CURATION_TYPE_UNSPECIFIED DEFAULT_CURATION_FOR_API_METADATA CUSTOM_CURATION_FOR_API_METADATA
    customCuration PluginInstanceActionCurationConfigCustomCuration
    Custom curation information for this plugin instance. Structure is documented below.
    curationType string
    Possible values: CURATION_TYPE_UNSPECIFIED DEFAULT_CURATION_FOR_API_METADATA CUSTOM_CURATION_FOR_API_METADATA
    customCuration PluginInstanceActionCurationConfigCustomCuration
    Custom curation information for this plugin instance. Structure is documented below.
    curation_type str
    Possible values: CURATION_TYPE_UNSPECIFIED DEFAULT_CURATION_FOR_API_METADATA CUSTOM_CURATION_FOR_API_METADATA
    custom_curation PluginInstanceActionCurationConfigCustomCuration
    Custom curation information for this plugin instance. Structure is documented below.
    curationType String
    Possible values: CURATION_TYPE_UNSPECIFIED DEFAULT_CURATION_FOR_API_METADATA CUSTOM_CURATION_FOR_API_METADATA
    customCuration Property Map
    Custom curation information for this plugin instance. Structure is documented below.

    PluginInstanceActionCurationConfigCustomCuration, PluginInstanceActionCurationConfigCustomCurationArgs

    Curation string
    The unique name of the curation resource. This will be the name of the curation resource in the format: projects/{project}/locations/{location}/curations/{curation}

    Curation string
    The unique name of the curation resource. This will be the name of the curation resource in the format: projects/{project}/locations/{location}/curations/{curation}

    curation String
    The unique name of the curation resource. This will be the name of the curation resource in the format: projects/{project}/locations/{location}/curations/{curation}

    curation string
    The unique name of the curation resource. This will be the name of the curation resource in the format: projects/{project}/locations/{location}/curations/{curation}

    curation str
    The unique name of the curation resource. This will be the name of the curation resource in the format: projects/{project}/locations/{location}/curations/{curation}

    curation String
    The unique name of the curation resource. This will be the name of the curation resource in the format: projects/{project}/locations/{location}/curations/{curation}

    PluginInstanceActionHubInstanceAction, PluginInstanceActionHubInstanceActionArgs

    CurrentExecutionState string
    The current state of the execution. Possible values: CURRENT_EXECUTION_STATE_UNSPECIFIED RUNNING NOT_RUNNING
    LastExecutions List<PluginInstanceActionHubInstanceActionLastExecution>
    The result of the last execution of the plugin instance.
    CurrentExecutionState string
    The current state of the execution. Possible values: CURRENT_EXECUTION_STATE_UNSPECIFIED RUNNING NOT_RUNNING
    LastExecutions []PluginInstanceActionHubInstanceActionLastExecution
    The result of the last execution of the plugin instance.
    currentExecutionState String
    The current state of the execution. Possible values: CURRENT_EXECUTION_STATE_UNSPECIFIED RUNNING NOT_RUNNING
    lastExecutions List<PluginInstanceActionHubInstanceActionLastExecution>
    The result of the last execution of the plugin instance.
    currentExecutionState string
    The current state of the execution. Possible values: CURRENT_EXECUTION_STATE_UNSPECIFIED RUNNING NOT_RUNNING
    lastExecutions PluginInstanceActionHubInstanceActionLastExecution[]
    The result of the last execution of the plugin instance.
    current_execution_state str
    The current state of the execution. Possible values: CURRENT_EXECUTION_STATE_UNSPECIFIED RUNNING NOT_RUNNING
    last_executions Sequence[PluginInstanceActionHubInstanceActionLastExecution]
    The result of the last execution of the plugin instance.
    currentExecutionState String
    The current state of the execution. Possible values: CURRENT_EXECUTION_STATE_UNSPECIFIED RUNNING NOT_RUNNING
    lastExecutions List<Property Map>
    The result of the last execution of the plugin instance.

    PluginInstanceActionHubInstanceActionLastExecution, PluginInstanceActionHubInstanceActionLastExecutionArgs

    EndTime string
    The last execution end time of the plugin instance.
    ErrorMessage 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.
    Result string
    The result of the last execution of the plugin instance. Possible values: RESULT_UNSPECIFIED SUCCEEDED FAILED
    StartTime string
    The last execution start time of the plugin instance.
    EndTime string
    The last execution end time of the plugin instance.
    ErrorMessage 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.
    Result string
    The result of the last execution of the plugin instance. Possible values: RESULT_UNSPECIFIED SUCCEEDED FAILED
    StartTime string
    The last execution start time of the plugin instance.
    endTime String
    The last execution end time of the plugin instance.
    errorMessage 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.
    result String
    The result of the last execution of the plugin instance. Possible values: RESULT_UNSPECIFIED SUCCEEDED FAILED
    startTime String
    The last execution start time of the plugin instance.
    endTime string
    The last execution end time of the plugin instance.
    errorMessage 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.
    result string
    The result of the last execution of the plugin instance. Possible values: RESULT_UNSPECIFIED SUCCEEDED FAILED
    startTime string
    The last execution start time of the plugin instance.
    end_time str
    The last execution end time of the plugin instance.
    error_message str
    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.
    result str
    The result of the last execution of the plugin instance. Possible values: RESULT_UNSPECIFIED SUCCEEDED FAILED
    start_time str
    The last execution start time of the plugin instance.
    endTime String
    The last execution end time of the plugin instance.
    errorMessage 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.
    result String
    The result of the last execution of the plugin instance. Possible values: RESULT_UNSPECIFIED SUCCEEDED FAILED
    startTime String
    The last execution start time of the plugin instance.

    PluginInstanceAuthConfig, PluginInstanceAuthConfigArgs

    AuthType string
    Possible values: AUTH_TYPE_UNSPECIFIED NO_AUTH GOOGLE_SERVICE_ACCOUNT USER_PASSWORD API_KEY OAUTH2_CLIENT_CREDENTIALS
    ApiKeyConfig PluginInstanceAuthConfigApiKeyConfig
    Config for authentication with API key. Structure is documented below.
    GoogleServiceAccountConfig PluginInstanceAuthConfigGoogleServiceAccountConfig
    Config for Google service account authentication. Structure is documented below.
    Oauth2ClientCredentialsConfig PluginInstanceAuthConfigOauth2ClientCredentialsConfig
    Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. Structure is documented below.
    UserPasswordConfig PluginInstanceAuthConfigUserPasswordConfig
    Parameters to support Username and Password Authentication. Structure is documented below.
    AuthType string
    Possible values: AUTH_TYPE_UNSPECIFIED NO_AUTH GOOGLE_SERVICE_ACCOUNT USER_PASSWORD API_KEY OAUTH2_CLIENT_CREDENTIALS
    ApiKeyConfig PluginInstanceAuthConfigApiKeyConfig
    Config for authentication with API key. Structure is documented below.
    GoogleServiceAccountConfig PluginInstanceAuthConfigGoogleServiceAccountConfig
    Config for Google service account authentication. Structure is documented below.
    Oauth2ClientCredentialsConfig PluginInstanceAuthConfigOauth2ClientCredentialsConfig
    Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. Structure is documented below.
    UserPasswordConfig PluginInstanceAuthConfigUserPasswordConfig
    Parameters to support Username and Password Authentication. Structure is documented below.
    authType String
    Possible values: AUTH_TYPE_UNSPECIFIED NO_AUTH GOOGLE_SERVICE_ACCOUNT USER_PASSWORD API_KEY OAUTH2_CLIENT_CREDENTIALS
    apiKeyConfig PluginInstanceAuthConfigApiKeyConfig
    Config for authentication with API key. Structure is documented below.
    googleServiceAccountConfig PluginInstanceAuthConfigGoogleServiceAccountConfig
    Config for Google service account authentication. Structure is documented below.
    oauth2ClientCredentialsConfig PluginInstanceAuthConfigOauth2ClientCredentialsConfig
    Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. Structure is documented below.
    userPasswordConfig PluginInstanceAuthConfigUserPasswordConfig
    Parameters to support Username and Password Authentication. Structure is documented below.
    authType string
    Possible values: AUTH_TYPE_UNSPECIFIED NO_AUTH GOOGLE_SERVICE_ACCOUNT USER_PASSWORD API_KEY OAUTH2_CLIENT_CREDENTIALS
    apiKeyConfig PluginInstanceAuthConfigApiKeyConfig
    Config for authentication with API key. Structure is documented below.
    googleServiceAccountConfig PluginInstanceAuthConfigGoogleServiceAccountConfig
    Config for Google service account authentication. Structure is documented below.
    oauth2ClientCredentialsConfig PluginInstanceAuthConfigOauth2ClientCredentialsConfig
    Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. Structure is documented below.
    userPasswordConfig PluginInstanceAuthConfigUserPasswordConfig
    Parameters to support Username and Password Authentication. Structure is documented below.
    auth_type str
    Possible values: AUTH_TYPE_UNSPECIFIED NO_AUTH GOOGLE_SERVICE_ACCOUNT USER_PASSWORD API_KEY OAUTH2_CLIENT_CREDENTIALS
    api_key_config PluginInstanceAuthConfigApiKeyConfig
    Config for authentication with API key. Structure is documented below.
    google_service_account_config PluginInstanceAuthConfigGoogleServiceAccountConfig
    Config for Google service account authentication. Structure is documented below.
    oauth2_client_credentials_config PluginInstanceAuthConfigOauth2ClientCredentialsConfig
    Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. Structure is documented below.
    user_password_config PluginInstanceAuthConfigUserPasswordConfig
    Parameters to support Username and Password Authentication. Structure is documented below.
    authType String
    Possible values: AUTH_TYPE_UNSPECIFIED NO_AUTH GOOGLE_SERVICE_ACCOUNT USER_PASSWORD API_KEY OAUTH2_CLIENT_CREDENTIALS
    apiKeyConfig Property Map
    Config for authentication with API key. Structure is documented below.
    googleServiceAccountConfig Property Map
    Config for Google service account authentication. Structure is documented below.
    oauth2ClientCredentialsConfig Property Map
    Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. Structure is documented below.
    userPasswordConfig Property Map
    Parameters to support Username and Password Authentication. Structure is documented below.

    PluginInstanceAuthConfigApiKeyConfig, PluginInstanceAuthConfigApiKeyConfigArgs

    ApiKey PluginInstanceAuthConfigApiKeyConfigApiKey
    Secret provides a reference to entries in Secret Manager. Structure is documented below.
    HttpElementLocation string
    The location of the API key. The default value is QUERY. Possible values: HTTP_ELEMENT_LOCATION_UNSPECIFIED QUERY HEADER PATH BODY COOKIE
    Name string
    The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
    ApiKey PluginInstanceAuthConfigApiKeyConfigApiKey
    Secret provides a reference to entries in Secret Manager. Structure is documented below.
    HttpElementLocation string
    The location of the API key. The default value is QUERY. Possible values: HTTP_ELEMENT_LOCATION_UNSPECIFIED QUERY HEADER PATH BODY COOKIE
    Name string
    The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
    apiKey PluginInstanceAuthConfigApiKeyConfigApiKey
    Secret provides a reference to entries in Secret Manager. Structure is documented below.
    httpElementLocation String
    The location of the API key. The default value is QUERY. Possible values: HTTP_ELEMENT_LOCATION_UNSPECIFIED QUERY HEADER PATH BODY COOKIE
    name String
    The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
    apiKey PluginInstanceAuthConfigApiKeyConfigApiKey
    Secret provides a reference to entries in Secret Manager. Structure is documented below.
    httpElementLocation string
    The location of the API key. The default value is QUERY. Possible values: HTTP_ELEMENT_LOCATION_UNSPECIFIED QUERY HEADER PATH BODY COOKIE
    name string
    The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
    api_key PluginInstanceAuthConfigApiKeyConfigApiKey
    Secret provides a reference to entries in Secret Manager. Structure is documented below.
    http_element_location str
    The location of the API key. The default value is QUERY. Possible values: HTTP_ELEMENT_LOCATION_UNSPECIFIED QUERY HEADER PATH BODY COOKIE
    name str
    The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
    apiKey Property Map
    Secret provides a reference to entries in Secret Manager. Structure is documented below.
    httpElementLocation String
    The location of the API key. The default value is QUERY. Possible values: HTTP_ELEMENT_LOCATION_UNSPECIFIED QUERY HEADER PATH BODY COOKIE
    name String
    The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.

    PluginInstanceAuthConfigApiKeyConfigApiKey, PluginInstanceAuthConfigApiKeyConfigApiKeyArgs

    SecretVersion string

    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.

    The oauth2_client_credentials_config block supports:

    SecretVersion string

    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.

    The oauth2_client_credentials_config block supports:

    secretVersion String

    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.

    The oauth2_client_credentials_config block supports:

    secretVersion string

    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.

    The oauth2_client_credentials_config block supports:

    secret_version str

    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.

    The oauth2_client_credentials_config block supports:

    secretVersion String

    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.

    The oauth2_client_credentials_config block supports:

    PluginInstanceAuthConfigGoogleServiceAccountConfig, PluginInstanceAuthConfigGoogleServiceAccountConfigArgs

    ServiceAccount string
    The service account to be used for authenticating request. The iam.serviceAccounts.getAccessToken permission should be granted on this service account to the impersonator service account.
    ServiceAccount string
    The service account to be used for authenticating request. The iam.serviceAccounts.getAccessToken permission should be granted on this service account to the impersonator service account.
    serviceAccount String
    The service account to be used for authenticating request. The iam.serviceAccounts.getAccessToken permission should be granted on this service account to the impersonator service account.
    serviceAccount string
    The service account to be used for authenticating request. The iam.serviceAccounts.getAccessToken permission should be granted on this service account to the impersonator service account.
    service_account str
    The service account to be used for authenticating request. The iam.serviceAccounts.getAccessToken permission should be granted on this service account to the impersonator service account.
    serviceAccount String
    The service account to be used for authenticating request. The iam.serviceAccounts.getAccessToken permission should be granted on this service account to the impersonator service account.

    PluginInstanceAuthConfigOauth2ClientCredentialsConfig, PluginInstanceAuthConfigOauth2ClientCredentialsConfigArgs

    ClientId string
    The client identifier.
    ClientSecret PluginInstanceAuthConfigOauth2ClientCredentialsConfigClientSecret
    Secret provides a reference to entries in Secret Manager.
    ClientId string
    The client identifier.
    ClientSecret PluginInstanceAuthConfigOauth2ClientCredentialsConfigClientSecret
    Secret provides a reference to entries in Secret Manager.
    clientId String
    The client identifier.
    clientSecret PluginInstanceAuthConfigOauth2ClientCredentialsConfigClientSecret
    Secret provides a reference to entries in Secret Manager.
    clientId string
    The client identifier.
    clientSecret PluginInstanceAuthConfigOauth2ClientCredentialsConfigClientSecret
    Secret provides a reference to entries in Secret Manager.
    client_id str
    The client identifier.
    client_secret PluginInstanceAuthConfigOauth2ClientCredentialsConfigClientSecret
    Secret provides a reference to entries in Secret Manager.
    clientId String
    The client identifier.
    clientSecret Property Map
    Secret provides a reference to entries in Secret Manager.

    PluginInstanceAuthConfigOauth2ClientCredentialsConfigClientSecret, PluginInstanceAuthConfigOauth2ClientCredentialsConfigClientSecretArgs

    SecretVersion string
    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.
    SecretVersion string
    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.
    secretVersion String
    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.
    secretVersion string
    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.
    secret_version str
    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.
    secretVersion String
    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.

    PluginInstanceAuthConfigUserPasswordConfig, PluginInstanceAuthConfigUserPasswordConfigArgs

    Password PluginInstanceAuthConfigUserPasswordConfigPassword
    Secret provides a reference to entries in Secret Manager. Structure is documented below.
    Username string
    Username.
    Password PluginInstanceAuthConfigUserPasswordConfigPassword
    Secret provides a reference to entries in Secret Manager. Structure is documented below.
    Username string
    Username.
    password PluginInstanceAuthConfigUserPasswordConfigPassword
    Secret provides a reference to entries in Secret Manager. Structure is documented below.
    username String
    Username.
    password PluginInstanceAuthConfigUserPasswordConfigPassword
    Secret provides a reference to entries in Secret Manager. Structure is documented below.
    username string
    Username.
    password PluginInstanceAuthConfigUserPasswordConfigPassword
    Secret provides a reference to entries in Secret Manager. Structure is documented below.
    username str
    Username.
    password Property Map
    Secret provides a reference to entries in Secret Manager. Structure is documented below.
    username String
    Username.

    PluginInstanceAuthConfigUserPasswordConfigPassword, PluginInstanceAuthConfigUserPasswordConfigPasswordArgs

    SecretVersion string
    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.
    SecretVersion string
    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.
    secretVersion String
    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.
    secretVersion string
    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.
    secret_version str
    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.
    secretVersion String
    The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.

    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:

    $ pulumi import gcp:apihub/pluginInstance:PluginInstance default projects/{{project}}/locations/{{location}}/plugins/{{plugin}}/instances/{{plugin_instance_id}}

    $ pulumi import gcp:apihub/pluginInstance:PluginInstance default {{project}}/{{location}}/{{plugin}}/{{plugin_instance_id}}

    $ pulumi import gcp:apihub/pluginInstance:PluginInstance default {{location}}/{{plugin}}/{{plugin_instance_id}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.37.0 published on Monday, Jul 7, 2025 by Pulumi
    pulumi/pulumi-gcp