MonitoredProject class

A project being monitored by a Metrics Scope.

To get more information about MonitoredProject, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Monitoring Monitored Project Basic

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

const basic = new gcp.organizations.Project("basic", {
    projectId: "m-id",
    name: "m-id-display",
    orgId: "123456789",
    deletionPolicy: "DELETE",
});
const primary = new gcp.monitoring.MonitoredProject("primary", {
    metricsScope: "my-project-name",
    name: basic.projectId,
});

import pulumi
import pulumi_gcp as gcp

basic = gcp.organizations.Project("basic",
    project_id="m-id",
    name="m-id-display",
    org_id="123456789",
    deletion_policy="DELETE")
primary = gcp.monitoring.MonitoredProject("primary",
    metrics_scope="my-project-name",
    name=basic.project_id)

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

return await Deployment.RunAsync(() =>
{
    var basic = new Gcp.Organizations.Project("basic", new()
    {
        ProjectId = "m-id",
        Name = "m-id-display",
        OrgId = "123456789",
        DeletionPolicy = "DELETE",
    });

    var primary = new Gcp.Monitoring.MonitoredProject("primary", new()
    {
        MetricsScope = "my-project-name",
        Name = basic.ProjectId,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		basic, err := organizations.NewProject(ctx, "basic", &organizations.ProjectArgs{
			ProjectId:      pulumi.String("m-id"),
			Name:           pulumi.String("m-id-display"),
			OrgId:          pulumi.String("123456789"),
			DeletionPolicy: pulumi.String("DELETE"),
		})
		if err != nil {
			return err
		}
		_, err = monitoring.NewMonitoredProject(ctx, "primary", &monitoring.MonitoredProjectArgs{
			MetricsScope: pulumi.String("my-project-name"),
			Name:         basic.ProjectId,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_monitoring_monitoredproject" "primary" {
  metrics_scope = "my-project-name"
  name          = gcp_organizations_project.basic.project_id
}
resource "gcp_organizations_project" "basic" {
  project_id      = "m-id"
  name            = "m-id-display"
  org_id          = "123456789"
  deletion_policy = "DELETE"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.Project;
import com.pulumi.gcp.organizations.ProjectArgs;
import com.pulumi.gcp.monitoring.MonitoredProject;
import com.pulumi.gcp.monitoring.MonitoredProjectArgs;
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 basic = new Project("basic", ProjectArgs.builder()
            .projectId("m-id")
            .name("m-id-display")
            .orgId("123456789")
            .deletionPolicy("DELETE")
            .build());

        var primary = new MonitoredProject("primary", MonitoredProjectArgs.builder()
            .metricsScope("my-project-name")
            .name(basic.projectId())
            .build());

    }
}

resources:
  primary:
    type: gcp:monitoring:MonitoredProject
    properties:
      metricsScope: my-project-name
      name: ${basic.projectId}
  basic:
    type: gcp:organizations:Project
    properties:
      projectId: m-id
      name: m-id-display
      orgId: '123456789'
      deletionPolicy: DELETE

Import

MonitoredProject can be imported using any of these accepted formats:

• v1/locations/global/metricsScopes/{{name}}
• {{name}}

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

$ pulumi import gcp:monitoring/monitoredProject:MonitoredProject default v1/locations/global/metricsScopes/{{name}}
$ pulumi import gcp:monitoring/monitoredProject:MonitoredProject default {{name}}

Constructors

MonitoredProject(String name, {MonitoredProjectArgs? args, CustomResourceOptions? options})

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

MonitoredProject.reference(String urn)

Creates a typed reference to an existing MonitoredProject resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Output only. The time when this MonitoredProject 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

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

metricsScope ↔ Output<String>

Required. The resource name of the existing Metrics Scope that will monitor this project. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}

late, final

name ↔ Output<String>

Immutable. The resource name of the MonitoredProject. On input, the resource name includes the scoping project ID and monitored project ID. On output, it contains the equivalent project numbers. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER}

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

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

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

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