DataConnectService class

A Firebase Data Connect service.

To get more information about Service, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Firebasedataconnect Service Basic

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

// Enable Firebase Data Connect API
const fdc = new gcp.projects.Service("fdc", {
    project: "my-project-name",
    service: "firebasedataconnect.googleapis.com",
});
// Create a Firebase Data Connect service
const _default = new gcp.firebase.DataConnectService("default", {
    project: "my-project-name",
    location: "us-central1",
    serviceId: "example-service",
    deletionPolicy: "DEFAULT",
    labels: {
        label: "my-label",
    },
    annotations: {
        key1: "value1",
        key2: "value2",
    },
}, {
    dependsOn: [fdc],
});

import pulumi
import pulumi_gcp as gcp

# Enable Firebase Data Connect API
fdc = gcp.projects.Service("fdc",
    project="my-project-name",
    service="firebasedataconnect.googleapis.com")
# Create a Firebase Data Connect service
default = gcp.firebase.DataConnectService("default",
    project="my-project-name",
    location="us-central1",
    service_id="example-service",
    deletion_policy="DEFAULT",
    labels={
        "label": "my-label",
    },
    annotations={
        "key1": "value1",
        "key2": "value2",
    },
    opts = pulumi.ResourceOptions(depends_on=[fdc]))

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

return await Deployment.RunAsync(() =>
{
    // Enable Firebase Data Connect API
    var fdc = new Gcp.Projects.Service("fdc", new()
    {
        Project = "my-project-name",
        ServiceName = "firebasedataconnect.googleapis.com",
    });

    // Create a Firebase Data Connect service
    var @default = new Gcp.Firebase.DataConnectService("default", new()
    {
        Project = "my-project-name",
        Location = "us-central1",
        ServiceId = "example-service",
        DeletionPolicy = "DEFAULT",
        Labels =
        {
            { "label", "my-label" },
        },
        Annotations =
        {
            { "key1", "value1" },
            { "key2", "value2" },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            fdc,
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Enable Firebase Data Connect API
		fdc, err := projects.NewService(ctx, "fdc", &projects.ServiceArgs{
			Project: pulumi.String("my-project-name"),
			Service: pulumi.String("firebasedataconnect.googleapis.com"),
		})
		if err != nil {
			return err
		}
		// Create a Firebase Data Connect service
		_, err = firebase.NewDataConnectService(ctx, "default", &firebase.DataConnectServiceArgs{
			Project:        pulumi.String("my-project-name"),
			Location:       pulumi.String("us-central1"),
			ServiceId:      pulumi.String("example-service"),
			DeletionPolicy: pulumi.String("DEFAULT"),
			Labels: pulumi.StringMap{
				"label": pulumi.String("my-label"),
			},
			Annotations: pulumi.StringMap{
				"key1": pulumi.String("value1"),
				"key2": pulumi.String("value2"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			fdc,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

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

# Enable Firebase Data Connect API
resource "gcp_projects_service" "fdc" {
  project = "my-project-name"
  service = "firebasedataconnect.googleapis.com"
}
# Create a Firebase Data Connect service
resource "gcp_firebase_dataconnectservice" "default" {
  depends_on      = [gcp_projects_service.fdc]
  project         = "my-project-name"
  location        = "us-central1"
  service_id      = "example-service"
  deletion_policy = "DEFAULT"
  labels = {
    "label" = "my-label"
  }
  annotations = {
    "key1" = "value1"
    "key2" = "value2"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.projects.Service;
import com.pulumi.gcp.projects.ServiceArgs;
import com.pulumi.gcp.firebase.DataConnectService;
import com.pulumi.gcp.firebase.DataConnectServiceArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
        // Enable Firebase Data Connect API
        var fdc = new Service("fdc", ServiceArgs.builder()
            .project("my-project-name")
            .service("firebasedataconnect.googleapis.com")
            .build());

        // Create a Firebase Data Connect service
        var default_ = new DataConnectService("default", DataConnectServiceArgs.builder()
            .project("my-project-name")
            .location("us-central1")
            .serviceId("example-service")
            .deletionPolicy("DEFAULT")
            .labels(Map.of("label", "my-label"))
            .annotations(Map.ofEntries(
                Map.entry("key1", "value1"),
                Map.entry("key2", "value2")
            ))
            .build(), CustomResourceOptions.builder()
                .dependsOn(fdc)
                .build());

    }
}

resources:
  # Enable Firebase Data Connect API
  fdc:
    type: gcp:projects:Service
    properties:
      project: my-project-name
      service: firebasedataconnect.googleapis.com
  # Create a Firebase Data Connect service
  default:
    type: gcp:firebase:DataConnectService
    properties:
      project: my-project-name
      location: us-central1
      serviceId: example-service
      deletionPolicy: DEFAULT
      labels:
        label: my-label
      annotations:
        key1: value1
        key2: value2
    options:
      dependsOn:
        - ${fdc}

Firebasedataconnect Service With Force Deletion

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

// Enable Firebase Data Connect API
const fdc = new gcp.projects.Service("fdc", {
    project: "my-project-name",
    service: "firebasedataconnect.googleapis.com",
});
// Create a Firebase Data Connect service
const _default = new gcp.firebase.DataConnectService("default", {
    project: "my-project-name",
    location: "us-central1",
    serviceId: "example-service",
    deletionPolicy: "FORCE",
}, {
    dependsOn: [fdc],
});

import pulumi
import pulumi_gcp as gcp

# Enable Firebase Data Connect API
fdc = gcp.projects.Service("fdc",
    project="my-project-name",
    service="firebasedataconnect.googleapis.com")
# Create a Firebase Data Connect service
default = gcp.firebase.DataConnectService("default",
    project="my-project-name",
    location="us-central1",
    service_id="example-service",
    deletion_policy="FORCE",
    opts = pulumi.ResourceOptions(depends_on=[fdc]))

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

return await Deployment.RunAsync(() =>
{
    // Enable Firebase Data Connect API
    var fdc = new Gcp.Projects.Service("fdc", new()
    {
        Project = "my-project-name",
        ServiceName = "firebasedataconnect.googleapis.com",
    });

    // Create a Firebase Data Connect service
    var @default = new Gcp.Firebase.DataConnectService("default", new()
    {
        Project = "my-project-name",
        Location = "us-central1",
        ServiceId = "example-service",
        DeletionPolicy = "FORCE",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            fdc,
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Enable Firebase Data Connect API
		fdc, err := projects.NewService(ctx, "fdc", &projects.ServiceArgs{
			Project: pulumi.String("my-project-name"),
			Service: pulumi.String("firebasedataconnect.googleapis.com"),
		})
		if err != nil {
			return err
		}
		// Create a Firebase Data Connect service
		_, err = firebase.NewDataConnectService(ctx, "default", &firebase.DataConnectServiceArgs{
			Project:        pulumi.String("my-project-name"),
			Location:       pulumi.String("us-central1"),
			ServiceId:      pulumi.String("example-service"),
			DeletionPolicy: pulumi.String("FORCE"),
		}, pulumi.DependsOn([]pulumi.Resource{
			fdc,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

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

# Enable Firebase Data Connect API
resource "gcp_projects_service" "fdc" {
  project = "my-project-name"
  service = "firebasedataconnect.googleapis.com"
}
# Create a Firebase Data Connect service
resource "gcp_firebase_dataconnectservice" "default" {
  depends_on      = [gcp_projects_service.fdc]
  project         = "my-project-name"
  location        = "us-central1"
  service_id      = "example-service"
  deletion_policy = "FORCE"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.projects.Service;
import com.pulumi.gcp.projects.ServiceArgs;
import com.pulumi.gcp.firebase.DataConnectService;
import com.pulumi.gcp.firebase.DataConnectServiceArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
        // Enable Firebase Data Connect API
        var fdc = new Service("fdc", ServiceArgs.builder()
            .project("my-project-name")
            .service("firebasedataconnect.googleapis.com")
            .build());

        // Create a Firebase Data Connect service
        var default_ = new DataConnectService("default", DataConnectServiceArgs.builder()
            .project("my-project-name")
            .location("us-central1")
            .serviceId("example-service")
            .deletionPolicy("FORCE")
            .build(), CustomResourceOptions.builder()
                .dependsOn(fdc)
                .build());

    }
}

resources:
  # Enable Firebase Data Connect API
  fdc:
    type: gcp:projects:Service
    properties:
      project: my-project-name
      service: firebasedataconnect.googleapis.com
  # Create a Firebase Data Connect service
  default:
    type: gcp:firebase:DataConnectService
    properties:
      project: my-project-name
      location: us-central1
      serviceId: example-service
      deletionPolicy: FORCE
    options:
      dependsOn:
        - ${fdc}

Import

Service can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/services/{{service_id}}
• {{project}}/{{location}}/{{service_id}}
• {{location}}/{{service_id}}

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

$ pulumi import gcp:firebase/dataConnectService:DataConnectService default projects/{{project}}/locations/{{location}}/services/{{service_id}}
$ pulumi import gcp:firebase/dataConnectService:DataConnectService default {{project}}/{{location}}/{{service_id}}
$ pulumi import gcp:firebase/dataConnectService:DataConnectService default {{location}}/{{service_id}}

Constructors

DataConnectService(String name, {DataConnectServiceArgs? args, CustomResourceOptions? options})

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

DataConnectService.reference(String urn)

Creates a typed reference to an existing DataConnectService resource.

Properties

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

Optional. Stores small amounts of arbitrary data. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effectiveAnnotations for all of the annotations present on the resource.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Output only. Output only Create time stamp.

late, final

deletionPolicy ↔ Output<String>

The deletion policy for the database. Setting the field to FORCE allows the Service to be deleted even if a Schema or Connector is present. By default, the Service deletion will only succeed when no Schema or Connectors are present.

late, final

displayName ↔ Output<String?>

Optional. Mutable human-readable name. 63 character limit.

late, final

effectiveAnnotations ↔ Output<Map<String, String>>

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

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

etag ↔ Output<String>

Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. AIP-154

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

Optional. Labels as key value pairs. 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>

The region in which the service resides, e.g. "us-central1" or "asia-east1".

late, final

name ↔ Output<String>

Identifier. The relative resource name of the Firebase Data Connect service, in the format:

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>

Output only. A field that if true, indicates that the system is working update the service.

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

serviceId ↔ Output<String>

Required. The ID to use for the service, which will become the final component of the service's resource name.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

uid ↔ Output<String>

Output only. System-assigned, unique identifier.

late, final

updateTime ↔ Output<String>

Output only. Output only Update time stamp.

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

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