PluginInstance class

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",
    }])

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 main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "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 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.ArrayList;
import java.util.Arrays;
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

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}}

Constructors

PluginInstance(String name, {PluginInstanceArgs? args, CustomResourceOptions? options}): Creates a new PluginInstance. name The Pulumi resource name. args Arguments used to configure this PluginInstance. The set of arguments for PluginInstance. options Resource options controlling this resource's behavior.
PluginInstance.reference(String urn): Creates a typed reference to an existing PluginInstance resource.

Properties

actions ↔ Output<List<PluginInstanceAction>>: The action status for the plugin instance. Structure is documented below.
latefinal
authConfig ↔ Output<PluginInstanceAuthConfig?>: AuthConfig represents the authentication information. Structure is documented below.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
createTime ↔ Output<String>: Timestamp indicating when the plugin instance was created.
latefinal
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
disable ↔ Output<bool?>: The display name for this plugin instance. Max length is 255 characters.
latefinal
displayName ↔ Output<String>: The display name for this plugin instance. Max length is 255 characters.
latefinal
errorMessage ↔ 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.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
location ↔ 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.
latefinal
name ↔ Output<String>: Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
latefinal
plugin ↔ 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.
latefinal
pluginInstanceId ↔ 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.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
sourceProjectId ↔ Output<String?>: Optional. The source project id of the plugin instance. This will be the id of runtime project in case of gcp based plugins and org id in case of non gcp based plugins. This field will be a required field for Google provided on-ramp plugins.
latefinal
state ↔ 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
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
updateTime ↔ Output<String>: Timestamp indicating when the plugin instance was last updated.
latefinal
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {PluginInstanceState? state, CustomResourceOptions? options}) → PluginInstance: Gets an existing PluginInstance resource's state with the given name and id.

PluginInstance class

Example Usage

Apihub Plugin Instance Basic

Import

Constructors

Properties

Methods

Operators

Static Methods

apihub library