LogScope class

Describes a group of resources to read log entries from

To get more information about LogScope, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Logging Log Scope Basic

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

const loggingLogScope = new gcp.logging.LogScope("logging_log_scope", {
    parent: "projects/my-project-name",
    location: "global",
    name: "projects/my-project-name/locations/global/logScopes/my-log-scope",
    resourceNames: [
        "projects/my-project-name",
        "projects/my-project-name/locations/global/buckets/_Default/views/view1",
        "projects/my-project-name/locations/global/buckets/_Default/views/view2",
    ],
    description: "A log scope configured with Terraform",
});

import pulumi
import pulumi_gcp as gcp

logging_log_scope = gcp.logging.LogScope("logging_log_scope",
    parent="projects/my-project-name",
    location="global",
    name="projects/my-project-name/locations/global/logScopes/my-log-scope",
    resource_names=[
        "projects/my-project-name",
        "projects/my-project-name/locations/global/buckets/_Default/views/view1",
        "projects/my-project-name/locations/global/buckets/_Default/views/view2",
    ],
    description="A log scope configured with Terraform")

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

return await Deployment.RunAsync(() =>
{
    var loggingLogScope = new Gcp.Logging.LogScope("logging_log_scope", new()
    {
        Parent = "projects/my-project-name",
        Location = "global",
        Name = "projects/my-project-name/locations/global/logScopes/my-log-scope",
        ResourceNames = new[]
        {
            "projects/my-project-name",
            "projects/my-project-name/locations/global/buckets/_Default/views/view1",
            "projects/my-project-name/locations/global/buckets/_Default/views/view2",
        },
        Description = "A log scope configured with Terraform",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := logging.NewLogScope(ctx, "logging_log_scope", &logging.LogScopeArgs{
			Parent:   pulumi.String("projects/my-project-name"),
			Location: pulumi.String("global"),
			Name:     pulumi.String("projects/my-project-name/locations/global/logScopes/my-log-scope"),
			ResourceNames: pulumi.StringArray{
				pulumi.String("projects/my-project-name"),
				pulumi.String("projects/my-project-name/locations/global/buckets/_Default/views/view1"),
				pulumi.String("projects/my-project-name/locations/global/buckets/_Default/views/view2"),
			},
			Description: pulumi.String("A log scope configured with Terraform"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_logging_logscope" "logging_log_scope" {
  parent         = "projects/my-project-name"
  location       = "global"
  name           = "projects/my-project-name/locations/global/logScopes/my-log-scope"
  resource_names = ["projects/my-project-name", "projects/my-project-name/locations/global/buckets/_Default/views/view1", "projects/my-project-name/locations/global/buckets/_Default/views/view2"]
  description    = "A log scope configured with Terraform"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.logging.LogScope;
import com.pulumi.gcp.logging.LogScopeArgs;
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 loggingLogScope = new LogScope("loggingLogScope", LogScopeArgs.builder()
            .parent("projects/my-project-name")
            .location("global")
            .name("projects/my-project-name/locations/global/logScopes/my-log-scope")
            .resourceNames(
                "projects/my-project-name",
                "projects/my-project-name/locations/global/buckets/_Default/views/view1",
                "projects/my-project-name/locations/global/buckets/_Default/views/view2")
            .description("A log scope configured with Terraform")
            .build());

    }
}

resources:
  loggingLogScope:
    type: gcp:logging:LogScope
    name: logging_log_scope
    properties:
      parent: projects/my-project-name
      location: global
      name: projects/my-project-name/locations/global/logScopes/my-log-scope
      resourceNames:
        - projects/my-project-name
        - projects/my-project-name/locations/global/buckets/_Default/views/view1
        - projects/my-project-name/locations/global/buckets/_Default/views/view2
      description: A log scope configured with Terraform

Import

LogScope can be imported using any of these accepted formats:

• {{parent}}/locations/{{location}}/logScopes/{{name}}

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

$ pulumi import gcp:logging/logScope:LogScope default {{parent}}/locations/{{location}}/logScopes/{{name}}

Constructors

LogScope(String name, {LogScopeArgs? args, CustomResourceOptions? options})

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

LogScope.reference(String urn)

Creates a typed reference to an existing LogScope resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Output only. The creation timestamp of the log scopes.

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

description ↔ Output<String?>

Describes this log scopes.

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

location ↔ Output<String>

The location of the resource. The only supported location is global so far.

late, final

name ↔ Output<String>

The resource name of the log scope. For example: `projects/my-project/locations/global/logScopes/my-log-scope`

late, final

parent ↔ Output<String>

The parent of the resource.

late, final

resourceNames ↔ Output<List<String>>

Names of one or more parent resources : * `projects/PROJECT_ID` May alternatively be one or more views : * `projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID` A log scope can include a maximum of 50 projects and a maximum of 100 resources in total.

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

updateTime ↔ Output<String>

Output only. The last update timestamp of the log scopes.

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

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