GdcServiceInstance class

A service instance is an instance of the Dataproc operator running on a GDC cluster.

To get more information about ServiceInstance, see:

• API documentation
• How-to Guides
• Dataproc Intro

Example Usage

Dataprocgdc Serviceinstance

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const service_instance = new gcp.dataproc.GdcServiceInstance("service-instance", {
    serviceInstanceId: "tf-e2e-service-instance",
    project: "my-project",
    location: "us-west2",
    gdceCluster: {
        gdceCluster: "projects/gdce-cluster-monitoring/locations/us-west2/clusters/gdce-prism-prober-ord106",
    },
    displayName: "A service instance",
    labels: {
        "test-label": "label-value",
    },
    serviceAccount: "[e-mail]",
});

import pulumi
import pulumi_gcp as gcp

service_instance = gcp.dataproc.GdcServiceInstance("service-instance",
    service_instance_id="tf-e2e-service-instance",
    project="my-project",
    location="us-west2",
    gdce_cluster={
        "gdce_cluster": "projects/gdce-cluster-monitoring/locations/us-west2/clusters/gdce-prism-prober-ord106",
    },
    display_name="A service instance",
    labels={
        "test-label": "label-value",
    },
    service_account="[e-mail]")

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

return await Deployment.RunAsync(() =>
{
    var service_instance = new Gcp.Dataproc.GdcServiceInstance("service-instance", new()
    {
        ServiceInstanceId = "tf-e2e-service-instance",
        Project = "my-project",
        Location = "us-west2",
        GdceCluster = new Gcp.Dataproc.Inputs.GdcServiceInstanceGdceClusterArgs
        {
            GdceCluster = "projects/gdce-cluster-monitoring/locations/us-west2/clusters/gdce-prism-prober-ord106",
        },
        DisplayName = "A service instance",
        Labels =
        {
            { "test-label", "label-value" },
        },
        ServiceAccount = "[e-mail]",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/dataproc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dataproc.NewGdcServiceInstance(ctx, "service-instance", &dataproc.GdcServiceInstanceArgs{
			ServiceInstanceId: pulumi.String("tf-e2e-service-instance"),
			Project:           pulumi.String("my-project"),
			Location:          pulumi.String("us-west2"),
			GdceCluster: &dataproc.GdcServiceInstanceGdceClusterArgs{
				GdceCluster: pulumi.String("projects/gdce-cluster-monitoring/locations/us-west2/clusters/gdce-prism-prober-ord106"),
			},
			DisplayName: pulumi.String("A service instance"),
			Labels: pulumi.StringMap{
				"test-label": pulumi.String("label-value"),
			},
			ServiceAccount: pulumi.String("[e-mail]"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_dataproc_gdcserviceinstance" "service-instance" {
  service_instance_id = "tf-e2e-service-instance"
  project             = "my-project"
  location            = "us-west2"
  gdce_cluster = {
    gdce_cluster = "projects/gdce-cluster-monitoring/locations/us-west2/clusters/gdce-prism-prober-ord106"
  }
  display_name = "A service instance"
  labels = {
    "test-label" = "label-value"
  }
  service_account = "[e-mail]"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.dataproc.GdcServiceInstance;
import com.pulumi.gcp.dataproc.GdcServiceInstanceArgs;
import com.pulumi.gcp.dataproc.inputs.GdcServiceInstanceGdceClusterArgs;
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 service_instance = new GdcServiceInstance("service-instance", GdcServiceInstanceArgs.builder()
            .serviceInstanceId("tf-e2e-service-instance")
            .project("my-project")
            .location("us-west2")
            .gdceCluster(GdcServiceInstanceGdceClusterArgs.builder()
                .gdceCluster("projects/gdce-cluster-monitoring/locations/us-west2/clusters/gdce-prism-prober-ord106")
                .build())
            .displayName("A service instance")
            .labels(Map.of("test-label", "label-value"))
            .serviceAccount("[e-mail]")
            .build());

    }
}

resources:
  service-instance:
    type: gcp:dataproc:GdcServiceInstance
    properties:
      serviceInstanceId: tf-e2e-service-instance
      project: my-project
      location: us-west2
      gdceCluster:
        gdceCluster: projects/gdce-cluster-monitoring/locations/us-west2/clusters/gdce-prism-prober-ord106
      displayName: A service instance
      labels:
        test-label: label-value
      serviceAccount: [e-mail]

Import

ServiceInstance can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/serviceInstances/{{service_instance_id}}
• {{project}}/{{location}}/{{service_instance_id}}
• {{location}}/{{service_instance_id}}

When using the pulumi import command, ServiceInstance can be imported using one of the formats above. For example:

$ pulumi import gcp:dataproc/gdcServiceInstance:GdcServiceInstance default projects/{{project}}/locations/{{location}}/serviceInstances/{{service_instance_id}}
$ pulumi import gcp:dataproc/gdcServiceInstance:GdcServiceInstance default {{project}}/{{location}}/{{service_instance_id}}
$ pulumi import gcp:dataproc/gdcServiceInstance:GdcServiceInstance default {{location}}/{{service_instance_id}}

Constructors

GdcServiceInstance(String name, {GdcServiceInstanceArgs? args, CustomResourceOptions? options})

Creates a new GdcServiceInstance. name The Pulumi resource name. args Arguments used to configure this GdcServiceInstance. The set of arguments for GdcServiceInstance. options Resource options controlling this resource's behavior.

GdcServiceInstance.reference(String urn)

Creates a typed reference to an existing GdcServiceInstance resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The timestamp when the resource was created.

late, final

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.

late, final

displayName ↔ Output<String?>

User-provided human-readable name to be used in user interfaces.

late, final

effectiveLabels ↔ Output<Map<String, String>>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

late, final

effectiveServiceAccount ↔ Output<String>

Effective service account associated with ServiceInstance. This will be the serviceAccount if specified. Otherwise, it will be an automatically created per-resource P4SA that also automatically has Fleet Workload. Identity bindings applied.

late, final

gdceCluster ↔ Output<GdcServiceInstanceGdceCluster?>

Gdce cluster information. Structure is documented below.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<String, String>?>

The labels to associate with this service instance. Labels may be used for filtering and billing tracking. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

late, final

location ↔ Output<String>

Location of the resource.

late, final

name ↔ Output<String>

Identifier. The name of the service instance.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

pulumiLabels ↔ Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

late, final

reconciling ↔ Output<bool>

Whether the service instance is currently reconciling. True if the current state of the resource does not match the intended state, and the system is working to reconcile them, whether or not the change was user initiated.

late, final

requestedState ↔ Output<String>

The intended state to which the service instance is reconciling. Possible values:

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serviceAccount ↔ Output<String?>

Requested service account to associate with ServiceInstance.

late, final

serviceInstanceId ↔ Output<String>

Id of the service instance.

late, final

sparkServiceInstanceConfig ↔ Output<Map<String, dynamic>?>

Spark-specific service instance configuration.

late, final

state ↔ Output<String>

The current state. Possible values:

late, final

stateMessage ↔ Output<String>

A message explaining the current state.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

uid ↔ Output<String>

System generated unique identifier for this service instance, formatted as UUID4.

late, final

updateTime ↔ Output<String>

The timestamp when the resource was most recently updated.

late, final

urn ↔ Output<String>

late, final, inherited

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, {GdcServiceInstanceState? state, CustomResourceOptions? options}) → GdcServiceInstance

Gets an existing GdcServiceInstance resource's state with the given name and id.