Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. dataproc
  5. GdcServiceInstance
Google Cloud v8.25.0 published on Thursday, Apr 3, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.dataproc.GdcServiceInstance

Explore with Pulumi AI

Google Cloud v8.25.0 published on Thursday, Apr 3, 2025 by Pulumi
pulumi/pulumi-gcp

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

To get more information about ServiceInstance, see:

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: "dataprocgdc-cep-workflows@gdce-cluster-monitoring.iam.gserviceaccount.com",
});
Copy
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="dataprocgdc-cep-workflows@gdce-cluster-monitoring.iam.gserviceaccount.com")
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/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("dataprocgdc-cep-workflows@gdce-cluster-monitoring.iam.gserviceaccount.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 = "dataprocgdc-cep-workflows@gdce-cluster-monitoring.iam.gserviceaccount.com",
    });

});
Copy
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.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 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("dataprocgdc-cep-workflows@gdce-cluster-monitoring.iam.gserviceaccount.com")
            .build());

    }
}
Copy
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: dataprocgdc-cep-workflows@gdce-cluster-monitoring.iam.gserviceaccount.com
Copy

Create GdcServiceInstance Resource

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

Constructor syntax

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

@overload
def GdcServiceInstance(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       location: Optional[str] = None,
                       service_instance_id: Optional[str] = None,
                       display_name: Optional[str] = None,
                       gdce_cluster: Optional[GdcServiceInstanceGdceClusterArgs] = None,
                       labels: Optional[Mapping[str, str]] = None,
                       project: Optional[str] = None,
                       service_account: Optional[str] = None,
                       spark_service_instance_config: Optional[GdcServiceInstanceSparkServiceInstanceConfigArgs] = None)
func NewGdcServiceInstance(ctx *Context, name string, args GdcServiceInstanceArgs, opts ...ResourceOption) (*GdcServiceInstance, error)
public GdcServiceInstance(string name, GdcServiceInstanceArgs args, CustomResourceOptions? opts = null)
public GdcServiceInstance(String name, GdcServiceInstanceArgs args)
public GdcServiceInstance(String name, GdcServiceInstanceArgs args, CustomResourceOptions options)

type: gcp:dataproc:GdcServiceInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GdcServiceInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GdcServiceInstanceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GdcServiceInstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GdcServiceInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GdcServiceInstanceArgs
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 gdcServiceInstanceResource = new Gcp.Dataproc.GdcServiceInstance("gdcServiceInstanceResource", new()
{
    Location = "string",
    ServiceInstanceId = "string",
    DisplayName = "string",
    GdceCluster = new Gcp.Dataproc.Inputs.GdcServiceInstanceGdceClusterArgs
    {
        GdceCluster = "string",
    },
    Labels = 
    {
        { "string", "string" },
    },
    Project = "string",
    ServiceAccount = "string",
    SparkServiceInstanceConfig = null,
});
Copy
example, err := dataproc.NewGdcServiceInstance(ctx, "gdcServiceInstanceResource", &dataproc.GdcServiceInstanceArgs{
	Location:          pulumi.String("string"),
	ServiceInstanceId: pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	GdceCluster: &dataproc.GdcServiceInstanceGdceClusterArgs{
		GdceCluster: pulumi.String("string"),
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project:                    pulumi.String("string"),
	ServiceAccount:             pulumi.String("string"),
	SparkServiceInstanceConfig: &dataproc.GdcServiceInstanceSparkServiceInstanceConfigArgs{},
})
Copy
var gdcServiceInstanceResource = new GdcServiceInstance("gdcServiceInstanceResource", GdcServiceInstanceArgs.builder()
    .location("string")
    .serviceInstanceId("string")
    .displayName("string")
    .gdceCluster(GdcServiceInstanceGdceClusterArgs.builder()
        .gdceCluster("string")
        .build())
    .labels(Map.of("string", "string"))
    .project("string")
    .serviceAccount("string")
    .sparkServiceInstanceConfig()
    .build());
Copy
gdc_service_instance_resource = gcp.dataproc.GdcServiceInstance("gdcServiceInstanceResource",
    location="string",
    service_instance_id="string",
    display_name="string",
    gdce_cluster={
        "gdce_cluster": "string",
    },
    labels={
        "string": "string",
    },
    project="string",
    service_account="string",
    spark_service_instance_config={})
Copy
const gdcServiceInstanceResource = new gcp.dataproc.GdcServiceInstance("gdcServiceInstanceResource", {
    location: "string",
    serviceInstanceId: "string",
    displayName: "string",
    gdceCluster: {
        gdceCluster: "string",
    },
    labels: {
        string: "string",
    },
    project: "string",
    serviceAccount: "string",
    sparkServiceInstanceConfig: {},
});
Copy
type: gcp:dataproc:GdcServiceInstance
properties:
    displayName: string
    gdceCluster:
        gdceCluster: string
    labels:
        string: string
    location: string
    project: string
    serviceAccount: string
    serviceInstanceId: string
    sparkServiceInstanceConfig: {}
Copy

GdcServiceInstance 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 GdcServiceInstance resource accepts the following input properties:

Location
This property is required.
Changes to this property will trigger replacement.
string
Location of the resource.
ServiceInstanceId
This property is required.
Changes to this property will trigger replacement.
string
Id of the service instance.

DisplayName Changes to this property will trigger replacement. string
User-provided human-readable name to be used in user interfaces.
GdceCluster Changes to this property will trigger replacement. GdcServiceInstanceGdceCluster
Gdce cluster information. Structure is documented below.
Labels Dictionary<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 effective_labels for all of the labels present on the resource.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ServiceAccount Changes to this property will trigger replacement. string
Requested service account to associate with ServiceInstance.
SparkServiceInstanceConfig Changes to this property will trigger replacement. GdcServiceInstanceSparkServiceInstanceConfig
Spark-specific service instance configuration.
Location
This property is required.
Changes to this property will trigger replacement.
string
Location of the resource.
ServiceInstanceId
This property is required.
Changes to this property will trigger replacement.
string
Id of the service instance.

DisplayName Changes to this property will trigger replacement. string
User-provided human-readable name to be used in user interfaces.
GdceCluster Changes to this property will trigger replacement. GdcServiceInstanceGdceClusterArgs
Gdce cluster information. Structure is documented below.
Labels 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 effective_labels for all of the labels present on the resource.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ServiceAccount Changes to this property will trigger replacement. string
Requested service account to associate with ServiceInstance.
SparkServiceInstanceConfig Changes to this property will trigger replacement. GdcServiceInstanceSparkServiceInstanceConfigArgs
Spark-specific service instance configuration.
location
This property is required.
Changes to this property will trigger replacement.
String
Location of the resource.
serviceInstanceId
This property is required.
Changes to this property will trigger replacement.
String
Id of the service instance.

displayName Changes to this property will trigger replacement. String
User-provided human-readable name to be used in user interfaces.
gdceCluster Changes to this property will trigger replacement. GdcServiceInstanceGdceCluster
Gdce cluster information. Structure is documented below.
labels 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 effective_labels for all of the labels present on the resource.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
serviceAccount Changes to this property will trigger replacement. String
Requested service account to associate with ServiceInstance.
sparkServiceInstanceConfig Changes to this property will trigger replacement. GdcServiceInstanceSparkServiceInstanceConfig
Spark-specific service instance configuration.
location
This property is required.
Changes to this property will trigger replacement.
string
Location of the resource.
serviceInstanceId
This property is required.
Changes to this property will trigger replacement.
string
Id of the service instance.

displayName Changes to this property will trigger replacement. string
User-provided human-readable name to be used in user interfaces.
gdceCluster Changes to this property will trigger replacement. GdcServiceInstanceGdceCluster
Gdce cluster information. Structure is documented below.
labels {[key: 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 effective_labels for all of the labels present on the resource.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
serviceAccount Changes to this property will trigger replacement. string
Requested service account to associate with ServiceInstance.
sparkServiceInstanceConfig Changes to this property will trigger replacement. GdcServiceInstanceSparkServiceInstanceConfig
Spark-specific service instance configuration.
location
This property is required.
Changes to this property will trigger replacement.
str
Location of the resource.
service_instance_id
This property is required.
Changes to this property will trigger replacement.
str
Id of the service instance.

display_name Changes to this property will trigger replacement. str
User-provided human-readable name to be used in user interfaces.
gdce_cluster Changes to this property will trigger replacement. GdcServiceInstanceGdceClusterArgs
Gdce cluster information. Structure is documented below.
labels Mapping[str, str]
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 effective_labels for all of the labels present on the resource.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
service_account Changes to this property will trigger replacement. str
Requested service account to associate with ServiceInstance.
spark_service_instance_config Changes to this property will trigger replacement. GdcServiceInstanceSparkServiceInstanceConfigArgs
Spark-specific service instance configuration.
location
This property is required.
Changes to this property will trigger replacement.
String
Location of the resource.
serviceInstanceId
This property is required.
Changes to this property will trigger replacement.
String
Id of the service instance.

displayName Changes to this property will trigger replacement. String
User-provided human-readable name to be used in user interfaces.
gdceCluster Changes to this property will trigger replacement. Property Map
Gdce cluster information. Structure is documented below.
labels Map<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 effective_labels for all of the labels present on the resource.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
serviceAccount Changes to this property will trigger replacement. String
Requested service account to associate with ServiceInstance.
sparkServiceInstanceConfig Changes to this property will trigger replacement. Property Map
Spark-specific service instance configuration.

Outputs

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

CreateTime string
The timestamp when the resource was created.
EffectiveLabels Dictionary<string, string>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
EffectiveServiceAccount string
Effective service account associated with ServiceInstance. This will be the service_account if specified. Otherwise, it will be an automatically created per-resource P4SA that also automatically has Fleet Workload. Identity bindings applied.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Identifier. The name of the service instance.
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
Reconciling 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.
RequestedState string
The intended state to which the service instance is reconciling. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
State string
The current state. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
StateMessage string
A message explaining the current state.
Uid string
System generated unique identifier for this service instance, formatted as UUID4.
UpdateTime string
The timestamp when the resource was most recently updated.
CreateTime string
The timestamp when the resource was created.
EffectiveLabels 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.
EffectiveServiceAccount string
Effective service account associated with ServiceInstance. This will be the service_account if specified. Otherwise, it will be an automatically created per-resource P4SA that also automatically has Fleet Workload. Identity bindings applied.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Identifier. The name of the service instance.
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
Reconciling 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.
RequestedState string
The intended state to which the service instance is reconciling. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
State string
The current state. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
StateMessage string
A message explaining the current state.
Uid string
System generated unique identifier for this service instance, formatted as UUID4.
UpdateTime string
The timestamp when the resource was most recently updated.
createTime String
The timestamp when the resource was created.
effectiveLabels 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.
effectiveServiceAccount String
Effective service account associated with ServiceInstance. This will be the service_account if specified. Otherwise, it will be an automatically created per-resource P4SA that also automatically has Fleet Workload. Identity bindings applied.
id String
The provider-assigned unique ID for this managed resource.
name String
Identifier. The name of the service instance.
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling Boolean
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.
requestedState String
The intended state to which the service instance is reconciling. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
state String
The current state. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
stateMessage String
A message explaining the current state.
uid String
System generated unique identifier for this service instance, formatted as UUID4.
updateTime String
The timestamp when the resource was most recently updated.
createTime string
The timestamp when the resource was created.
effectiveLabels {[key: string]: string}
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
effectiveServiceAccount string
Effective service account associated with ServiceInstance. This will be the service_account if specified. Otherwise, it will be an automatically created per-resource P4SA that also automatically has Fleet Workload. Identity bindings applied.
id string
The provider-assigned unique ID for this managed resource.
name string
Identifier. The name of the service instance.
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling boolean
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.
requestedState string
The intended state to which the service instance is reconciling. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
state string
The current state. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
stateMessage string
A message explaining the current state.
uid string
System generated unique identifier for this service instance, formatted as UUID4.
updateTime string
The timestamp when the resource was most recently updated.
create_time str
The timestamp when the resource was created.
effective_labels Mapping[str, str]
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
effective_service_account str
Effective service account associated with ServiceInstance. This will be the service_account if specified. Otherwise, it will be an automatically created per-resource P4SA that also automatically has Fleet Workload. Identity bindings applied.
id str
The provider-assigned unique ID for this managed resource.
name str
Identifier. The name of the service instance.
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling 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.
requested_state str
The intended state to which the service instance is reconciling. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
state str
The current state. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
state_message str
A message explaining the current state.
uid str
System generated unique identifier for this service instance, formatted as UUID4.
update_time str
The timestamp when the resource was most recently updated.
createTime String
The timestamp when the resource was created.
effectiveLabels Map<String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
effectiveServiceAccount String
Effective service account associated with ServiceInstance. This will be the service_account if specified. Otherwise, it will be an automatically created per-resource P4SA that also automatically has Fleet Workload. Identity bindings applied.
id String
The provider-assigned unique ID for this managed resource.
name String
Identifier. The name of the service instance.
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling Boolean
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.
requestedState String
The intended state to which the service instance is reconciling. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
state String
The current state. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
stateMessage String
A message explaining the current state.
uid String
System generated unique identifier for this service instance, formatted as UUID4.
updateTime String
The timestamp when the resource was most recently updated.

Look up Existing GdcServiceInstance Resource

Get an existing GdcServiceInstance 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?: GdcServiceInstanceState, opts?: CustomResourceOptions): GdcServiceInstance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        display_name: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        effective_service_account: Optional[str] = None,
        gdce_cluster: Optional[GdcServiceInstanceGdceClusterArgs] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        reconciling: Optional[bool] = None,
        requested_state: Optional[str] = None,
        service_account: Optional[str] = None,
        service_instance_id: Optional[str] = None,
        spark_service_instance_config: Optional[GdcServiceInstanceSparkServiceInstanceConfigArgs] = None,
        state: Optional[str] = None,
        state_message: Optional[str] = None,
        uid: Optional[str] = None,
        update_time: Optional[str] = None) -> GdcServiceInstance
func GetGdcServiceInstance(ctx *Context, name string, id IDInput, state *GdcServiceInstanceState, opts ...ResourceOption) (*GdcServiceInstance, error)
public static GdcServiceInstance Get(string name, Input<string> id, GdcServiceInstanceState? state, CustomResourceOptions? opts = null)
public static GdcServiceInstance get(String name, Output<String> id, GdcServiceInstanceState state, CustomResourceOptions options)
resources:  _:    type: gcp:dataproc:GdcServiceInstance    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CreateTime string
The timestamp when the resource was created.
DisplayName Changes to this property will trigger replacement. string
User-provided human-readable name to be used in user interfaces.
EffectiveLabels Changes to this property will trigger replacement. Dictionary<string, string>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
EffectiveServiceAccount string
Effective service account associated with ServiceInstance. This will be the service_account if specified. Otherwise, it will be an automatically created per-resource P4SA that also automatically has Fleet Workload. Identity bindings applied.
GdceCluster Changes to this property will trigger replacement. GdcServiceInstanceGdceCluster
Gdce cluster information. Structure is documented below.
Labels Dictionary<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 effective_labels for all of the labels present on the resource.
Location Changes to this property will trigger replacement. string
Location of the resource.
Name string
Identifier. The name of the service instance.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
Reconciling 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.
RequestedState string
The intended state to which the service instance is reconciling. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
ServiceAccount Changes to this property will trigger replacement. string
Requested service account to associate with ServiceInstance.
ServiceInstanceId Changes to this property will trigger replacement. string
Id of the service instance.

SparkServiceInstanceConfig Changes to this property will trigger replacement. GdcServiceInstanceSparkServiceInstanceConfig
Spark-specific service instance configuration.
State string
The current state. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
StateMessage string
A message explaining the current state.
Uid string
System generated unique identifier for this service instance, formatted as UUID4.
UpdateTime string
The timestamp when the resource was most recently updated.
CreateTime string
The timestamp when the resource was created.
DisplayName Changes to this property will trigger replacement. string
User-provided human-readable name to be used in user interfaces.
EffectiveLabels Changes to this property will trigger replacement. 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.
EffectiveServiceAccount string
Effective service account associated with ServiceInstance. This will be the service_account if specified. Otherwise, it will be an automatically created per-resource P4SA that also automatically has Fleet Workload. Identity bindings applied.
GdceCluster Changes to this property will trigger replacement. GdcServiceInstanceGdceClusterArgs
Gdce cluster information. Structure is documented below.
Labels 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 effective_labels for all of the labels present on the resource.
Location Changes to this property will trigger replacement. string
Location of the resource.
Name string
Identifier. The name of the service instance.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
Reconciling 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.
RequestedState string
The intended state to which the service instance is reconciling. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
ServiceAccount Changes to this property will trigger replacement. string
Requested service account to associate with ServiceInstance.
ServiceInstanceId Changes to this property will trigger replacement. string
Id of the service instance.

SparkServiceInstanceConfig Changes to this property will trigger replacement. GdcServiceInstanceSparkServiceInstanceConfigArgs
Spark-specific service instance configuration.
State string
The current state. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
StateMessage string
A message explaining the current state.
Uid string
System generated unique identifier for this service instance, formatted as UUID4.
UpdateTime string
The timestamp when the resource was most recently updated.
createTime String
The timestamp when the resource was created.
displayName Changes to this property will trigger replacement. String
User-provided human-readable name to be used in user interfaces.
effectiveLabels Changes to this property will trigger replacement. 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.
effectiveServiceAccount String
Effective service account associated with ServiceInstance. This will be the service_account if specified. Otherwise, it will be an automatically created per-resource P4SA that also automatically has Fleet Workload. Identity bindings applied.
gdceCluster Changes to this property will trigger replacement. GdcServiceInstanceGdceCluster
Gdce cluster information. Structure is documented below.
labels 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 effective_labels for all of the labels present on the resource.
location Changes to this property will trigger replacement. String
Location of the resource.
name String
Identifier. The name of the service instance.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling Boolean
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.
requestedState String
The intended state to which the service instance is reconciling. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
serviceAccount Changes to this property will trigger replacement. String
Requested service account to associate with ServiceInstance.
serviceInstanceId Changes to this property will trigger replacement. String
Id of the service instance.

sparkServiceInstanceConfig Changes to this property will trigger replacement. GdcServiceInstanceSparkServiceInstanceConfig
Spark-specific service instance configuration.
state String
The current state. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
stateMessage String
A message explaining the current state.
uid String
System generated unique identifier for this service instance, formatted as UUID4.
updateTime String
The timestamp when the resource was most recently updated.
createTime string
The timestamp when the resource was created.
displayName Changes to this property will trigger replacement. string
User-provided human-readable name to be used in user interfaces.
effectiveLabels Changes to this property will trigger replacement. {[key: string]: string}
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
effectiveServiceAccount string
Effective service account associated with ServiceInstance. This will be the service_account if specified. Otherwise, it will be an automatically created per-resource P4SA that also automatically has Fleet Workload. Identity bindings applied.
gdceCluster Changes to this property will trigger replacement. GdcServiceInstanceGdceCluster
Gdce cluster information. Structure is documented below.
labels {[key: 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 effective_labels for all of the labels present on the resource.
location Changes to this property will trigger replacement. string
Location of the resource.
name string
Identifier. The name of the service instance.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling boolean
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.
requestedState string
The intended state to which the service instance is reconciling. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
serviceAccount Changes to this property will trigger replacement. string
Requested service account to associate with ServiceInstance.
serviceInstanceId Changes to this property will trigger replacement. string
Id of the service instance.

sparkServiceInstanceConfig Changes to this property will trigger replacement. GdcServiceInstanceSparkServiceInstanceConfig
Spark-specific service instance configuration.
state string
The current state. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
stateMessage string
A message explaining the current state.
uid string
System generated unique identifier for this service instance, formatted as UUID4.
updateTime string
The timestamp when the resource was most recently updated.
create_time str
The timestamp when the resource was created.
display_name Changes to this property will trigger replacement. str
User-provided human-readable name to be used in user interfaces.
effective_labels Changes to this property will trigger replacement. Mapping[str, str]
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
effective_service_account str
Effective service account associated with ServiceInstance. This will be the service_account if specified. Otherwise, it will be an automatically created per-resource P4SA that also automatically has Fleet Workload. Identity bindings applied.
gdce_cluster Changes to this property will trigger replacement. GdcServiceInstanceGdceClusterArgs
Gdce cluster information. Structure is documented below.
labels Mapping[str, str]
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 effective_labels for all of the labels present on the resource.
location Changes to this property will trigger replacement. str
Location of the resource.
name str
Identifier. The name of the service instance.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling 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.
requested_state str
The intended state to which the service instance is reconciling. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
service_account Changes to this property will trigger replacement. str
Requested service account to associate with ServiceInstance.
service_instance_id Changes to this property will trigger replacement. str
Id of the service instance.

spark_service_instance_config Changes to this property will trigger replacement. GdcServiceInstanceSparkServiceInstanceConfigArgs
Spark-specific service instance configuration.
state str
The current state. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
state_message str
A message explaining the current state.
uid str
System generated unique identifier for this service instance, formatted as UUID4.
update_time str
The timestamp when the resource was most recently updated.
createTime String
The timestamp when the resource was created.
displayName Changes to this property will trigger replacement. String
User-provided human-readable name to be used in user interfaces.
effectiveLabels Changes to this property will trigger replacement. Map<String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
effectiveServiceAccount String
Effective service account associated with ServiceInstance. This will be the service_account if specified. Otherwise, it will be an automatically created per-resource P4SA that also automatically has Fleet Workload. Identity bindings applied.
gdceCluster Changes to this property will trigger replacement. Property Map
Gdce cluster information. Structure is documented below.
labels Map<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 effective_labels for all of the labels present on the resource.
location Changes to this property will trigger replacement. String
Location of the resource.
name String
Identifier. The name of the service instance.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling Boolean
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.
requestedState String
The intended state to which the service instance is reconciling. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
serviceAccount Changes to this property will trigger replacement. String
Requested service account to associate with ServiceInstance.
serviceInstanceId Changes to this property will trigger replacement. String
Id of the service instance.

sparkServiceInstanceConfig Changes to this property will trigger replacement. Property Map
Spark-specific service instance configuration.
state String
The current state. Possible values:

  • CREATING
  • ACTIVE
  • DISCONNECTED
  • DELETING
  • STOPPING
  • STOPPED
  • STARTING
  • UPDATING
  • FAILED
stateMessage String
A message explaining the current state.
uid String
System generated unique identifier for this service instance, formatted as UUID4.
updateTime String
The timestamp when the resource was most recently updated.

Supporting Types

GdcServiceInstanceGdceCluster
, GdcServiceInstanceGdceClusterArgs

GdceCluster
This property is required.
Changes to this property will trigger replacement.
string
Gdce cluster resource id.
GdceCluster
This property is required.
Changes to this property will trigger replacement.
string
Gdce cluster resource id.
gdceCluster
This property is required.
Changes to this property will trigger replacement.
String
Gdce cluster resource id.
gdceCluster
This property is required.
Changes to this property will trigger replacement.
string
Gdce cluster resource id.
gdce_cluster
This property is required.
Changes to this property will trigger replacement.
str
Gdce cluster resource id.
gdceCluster
This property is required.
Changes to this property will trigger replacement.
String
Gdce cluster resource id.

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}}
Copy
$ pulumi import gcp:dataproc/gdcServiceInstance:GdcServiceInstance default {{project}}/{{location}}/{{service_instance_id}}
Copy
$ pulumi import gcp:dataproc/gdcServiceInstance:GdcServiceInstance default {{location}}/{{service_instance_id}}
Copy

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.
Google Cloud v8.25.0 published on Thursday, Apr 3, 2025 by Pulumi
pulumi/pulumi-gcp