ProjectSettings class

Manages Cloud Observability settings for a project.

> Warning: This resource is in beta, and should be used with the terraform-provider-google-beta provider. See Provider Versions for more details on beta resources.

Example Usage

Observability Project Settings Basic Global

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

const project = new gcp.organizations.Project("project", {
    projectId: "tf-test_42057",
    name: "tf-test_84735",
    orgId: "123456789",
    deletionPolicy: "DELETE",
});
const observabilityApi = new gcp.projects.Service("observability_api", {
    project: project.projectId,
    service: "observability.googleapis.com",
    disableOnDestroy: false,
});
// Wait for the project to be created and recognized by the Observability API
const waitForSettingsPropagation = new time.Sleep("wait_for_settings_propagation", {createDuration: "90s"}, {
    dependsOn: [observabilityApi],
});
const primaryGlobal = new gcp.observability.ProjectSettings("primary_global", {
    location: "global",
    project: project.projectId,
    defaultStorageLocation: "eu",
}, {
    dependsOn: [waitForSettingsPropagation],
});

import pulumi
import pulumi_gcp as gcp
import pulumiverse_time as time

project = gcp.organizations.Project("project",
    project_id="tf-test_42057",
    name="tf-test_84735",
    org_id="123456789",
    deletion_policy="DELETE")
observability_api = gcp.projects.Service("observability_api",
    project=project.project_id,
    service="observability.googleapis.com",
    disable_on_destroy=False)
# Wait for the project to be created and recognized by the Observability API
wait_for_settings_propagation = time.Sleep("wait_for_settings_propagation", create_duration="90s",
opts = pulumi.ResourceOptions(depends_on=[observability_api]))
primary_global = gcp.observability.ProjectSettings("primary_global",
    location="global",
    project=project.project_id,
    default_storage_location="eu",
    opts = pulumi.ResourceOptions(depends_on=[wait_for_settings_propagation]))

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

return await Deployment.RunAsync(() =>
{
    var project = new Gcp.Organizations.Project("project", new()
    {
        ProjectId = "tf-test_42057",
        Name = "tf-test_84735",
        OrgId = "123456789",
        DeletionPolicy = "DELETE",
    });

    var observabilityApi = new Gcp.Projects.Service("observability_api", new()
    {
        Project = project.ProjectId,
        ServiceName = "observability.googleapis.com",
        DisableOnDestroy = false,
    });

    // Wait for the project to be created and recognized by the Observability API
    var waitForSettingsPropagation = new Time.Sleep("wait_for_settings_propagation", new()
    {
        CreateDuration = "90s",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            observabilityApi,
        },
    });

    var primaryGlobal = new Gcp.Observability.ProjectSettings("primary_global", new()
    {
        Location = "global",
        Project = project.ProjectId,
        DefaultStorageLocation = "eu",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            waitForSettingsPropagation,
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/observability"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/projects"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-time/sdk/go/time"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		project, err := organizations.NewProject(ctx, "project", &organizations.ProjectArgs{
			ProjectId:      pulumi.String("tf-test_42057"),
			Name:           pulumi.String("tf-test_84735"),
			OrgId:          pulumi.String("123456789"),
			DeletionPolicy: pulumi.String("DELETE"),
		})
		if err != nil {
			return err
		}
		observabilityApi, err := projects.NewService(ctx, "observability_api", &projects.ServiceArgs{
			Project:          project.ProjectId,
			Service:          pulumi.String("observability.googleapis.com"),
			DisableOnDestroy: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		// Wait for the project to be created and recognized by the Observability API
		waitForSettingsPropagation, err := time.NewSleep(ctx, "wait_for_settings_propagation", &time.SleepArgs{
			CreateDuration: pulumi.String("90s"),
		}, pulumi.DependsOn([]pulumi.Resource{
			observabilityApi,
		}))
		if err != nil {
			return err
		}
		_, err = observability.NewProjectSettings(ctx, "primary_global", &observability.ProjectSettingsArgs{
			Location:               pulumi.String("global"),
			Project:                project.ProjectId,
			DefaultStorageLocation: pulumi.String("eu"),
		}, pulumi.DependsOn([]pulumi.Resource{
			waitForSettingsPropagation,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_organizations_project" "project" {
  project_id      = "tf-test_42057"
  name            = "tf-test_84735"
  org_id          = "123456789"
  deletion_policy = "DELETE"
}
resource "gcp_projects_service" "observability_api" {
  project            = gcp_organizations_project.project.project_id
  service            = "observability.googleapis.com"
  disable_on_destroy = false
}
# Wait for the project to be created and recognized by the Observability API
resource "time_sleep" "wait_for_settings_propagation" {
  depends_on      = [gcp_projects_service.observability_api]
  create_duration = "90s"
}
resource "gcp_observability_projectsettings" "primary_global" {
  depends_on               = [time_sleep.wait_for_settings_propagation]
  location                 = "global"
  project                  = gcp_organizations_project.project.project_id
  default_storage_location = "eu"
}

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.projects.Service;
import com.pulumi.gcp.projects.ServiceArgs;
import com.pulumiverse.time.Sleep;
import com.pulumiverse.time.SleepArgs;
import com.pulumi.gcp.observability.ProjectSettings;
import com.pulumi.gcp.observability.ProjectSettingsArgs;
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) {
        var project = new Project("project", ProjectArgs.builder()
            .projectId("tf-test_42057")
            .name("tf-test_84735")
            .orgId("123456789")
            .deletionPolicy("DELETE")
            .build());

        var observabilityApi = new Service("observabilityApi", ServiceArgs.builder()
            .project(project.projectId())
            .service("observability.googleapis.com")
            .disableOnDestroy(false)
            .build());

        // Wait for the project to be created and recognized by the Observability API
        var waitForSettingsPropagation = new Sleep("waitForSettingsPropagation", SleepArgs.builder()
            .createDuration("90s")
            .build(), CustomResourceOptions.builder()
                .dependsOn(observabilityApi)
                .build());

        var primaryGlobal = new ProjectSettings("primaryGlobal", ProjectSettingsArgs.builder()
            .location("global")
            .project(project.projectId())
            .defaultStorageLocation("eu")
            .build(), CustomResourceOptions.builder()
                .dependsOn(waitForSettingsPropagation)
                .build());

    }
}

resources:
  project:
    type: gcp:organizations:Project
    properties:
      projectId: tf-test_42057
      name: tf-test_84735
      orgId: '123456789'
      deletionPolicy: DELETE
  observabilityApi:
    type: gcp:projects:Service
    name: observability_api
    properties:
      project: ${project.projectId}
      service: observability.googleapis.com
      disableOnDestroy: false
  # Wait for the project to be created and recognized by the Observability API
  waitForSettingsPropagation:
    type: time:Sleep
    name: wait_for_settings_propagation
    properties:
      createDuration: 90s
    options:
      dependsOn:
        - ${observabilityApi}
  primaryGlobal:
    type: gcp:observability:ProjectSettings
    name: primary_global
    properties:
      location: global
      project: ${project.projectId}
      defaultStorageLocation: eu
    options:
      dependsOn:
        - ${waitForSettingsPropagation}

Import

ProjectSettings can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/settings
• {{project}}/{{location}}
• {{location}}

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

$ pulumi import gcp:observability/projectSettings:ProjectSettings default projects/{{project}}/locations/{{location}}/settings
$ pulumi import gcp:observability/projectSettings:ProjectSettings default {{project}}/{{location}}
$ pulumi import gcp:observability/projectSettings:ProjectSettings default {{location}}

Constructors

ProjectSettings(String name, {ProjectSettingsArgs? args, CustomResourceOptions? options})

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

ProjectSettings.reference(String urn)

Creates a typed reference to an existing ProjectSettings resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

defaultStorageLocation ↔ Output<String?>

The default storage location for new resources, e.g. buckets. Only valid for global location.

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

kmsKeyName ↔ Output<String?>

The default Cloud KMS key to use for new resources. Only valid for regional locations.

late, final

location ↔ Output<String>

The location of the settings.

late, final

name ↔ Output<String>

The resource name of the settings.

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

serviceAccountId ↔ Output<String>

The service account used by Cloud Observability for this project.

late, final

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

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