CustomService class

A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern. In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible

To get more information about Service, see:

• API documentation
• How-to Guides
• Monitoring API Documentation
• Service Monitoring
• Service-orientation on Wikipedia

Example Usage

Monitoring Service Custom

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

const custom = new gcp.monitoring.CustomService("custom", {
    serviceId: "custom-srv",
    displayName: "My Custom Service custom-srv",
    telemetry: {
        resourceName: "//product.googleapis.com/foo/foo/services/test",
    },
    userLabels: {
        my_key: "my_value",
        my_other_key: "my_other_value",
    },
});

import pulumi
import pulumi_gcp as gcp

custom = gcp.monitoring.CustomService("custom",
    service_id="custom-srv",
    display_name="My Custom Service custom-srv",
    telemetry={
        "resource_name": "//product.googleapis.com/foo/foo/services/test",
    },
    user_labels={
        "my_key": "my_value",
        "my_other_key": "my_other_value",
    })

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

return await Deployment.RunAsync(() =>
{
    var custom = new Gcp.Monitoring.CustomService("custom", new()
    {
        ServiceId = "custom-srv",
        DisplayName = "My Custom Service custom-srv",
        Telemetry = new Gcp.Monitoring.Inputs.CustomServiceTelemetryArgs
        {
            ResourceName = "//product.googleapis.com/foo/foo/services/test",
        },
        UserLabels =
        {
            { "my_key", "my_value" },
            { "my_other_key", "my_other_value" },
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := monitoring.NewCustomService(ctx, "custom", &monitoring.CustomServiceArgs{
			ServiceId:   pulumi.String("custom-srv"),
			DisplayName: pulumi.String("My Custom Service custom-srv"),
			Telemetry: &monitoring.CustomServiceTelemetryArgs{
				ResourceName: pulumi.String("//product.googleapis.com/foo/foo/services/test"),
			},
			UserLabels: pulumi.StringMap{
				"my_key":       pulumi.String("my_value"),
				"my_other_key": pulumi.String("my_other_value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_monitoring_customservice" "custom" {
  service_id   = "custom-srv"
  display_name = "My Custom Service custom-srv"
  telemetry = {
    resource_name = "//product.googleapis.com/foo/foo/services/test"
  }
  user_labels = {
    "my_key"       = "my_value"
    "my_other_key" = "my_other_value"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.monitoring.CustomService;
import com.pulumi.gcp.monitoring.CustomServiceArgs;
import com.pulumi.gcp.monitoring.inputs.CustomServiceTelemetryArgs;
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 custom = new CustomService("custom", CustomServiceArgs.builder()
            .serviceId("custom-srv")
            .displayName("My Custom Service custom-srv")
            .telemetry(CustomServiceTelemetryArgs.builder()
                .resourceName("//product.googleapis.com/foo/foo/services/test")
                .build())
            .userLabels(Map.ofEntries(
                Map.entry("my_key", "my_value"),
                Map.entry("my_other_key", "my_other_value")
            ))
            .build());

    }
}

resources:
  custom:
    type: gcp:monitoring:CustomService
    properties:
      serviceId: custom-srv
      displayName: My Custom Service custom-srv
      telemetry:
        resourceName: //product.googleapis.com/foo/foo/services/test
      userLabels:
        my_key: my_value
        my_other_key: my_other_value

Import

Service can be imported using any of these accepted formats:

• {{project}}/{{name}}
• {{project}} {{name}}
• {{name}}

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

$ pulumi import gcp:monitoring/customService:CustomService default {{project}}/{{name}}
$ terraform import google_monitoring_custom_service.default "{{project}} {{name}}"
$ pulumi import gcp:monitoring/customService:CustomService default {{name}}

Constructors

CustomService(String name, {CustomServiceArgs? args, CustomResourceOptions? options})

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

CustomService.reference(String urn)

Creates a typed reference to an existing CustomService resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

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

Name used for UI elements listing this Service.

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

name ↔ Output<String>

The full resource name for this service. The syntax is: projects/PROJECT_ID/services/SERVICE_ID.

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

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>

An optional service ID to use. If not given, the server will generate a service ID.

late, final

telemetry ↔ Output<CustomServiceTelemetry?>

Configuration for how to query telemetry on a Service. Structure is documented below.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

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

Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.

late, final

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

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