ProjectExclusion class
Manages a project-level logging exclusion. For more information see:
- API documentation
- How-to Guides
- Excluding Logs
> You can specify exclusions for log sinks created by the provider by using the exclusions field of gcp.logging.ProjectSink
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const my_exclusion = new gcp.logging.ProjectExclusion("my-exclusion", {
name: "my-instance-debug-exclusion",
description: "Exclude GCE instance debug logs",
filter: "resource.type = gce_instance AND severity <= DEBUG",
});
import pulumi
import pulumi_gcp as gcp
my_exclusion = gcp.logging.ProjectExclusion("my-exclusion",
name="my-instance-debug-exclusion",
description="Exclude GCE instance debug logs",
filter="resource.type = gce_instance AND severity <= DEBUG")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var my_exclusion = new Gcp.Logging.ProjectExclusion("my-exclusion", new()
{
Name = "my-instance-debug-exclusion",
Description = "Exclude GCE instance debug logs",
Filter = "resource.type = gce_instance AND severity <= DEBUG",
});
});
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.NewProjectExclusion(ctx, "my-exclusion", &logging.ProjectExclusionArgs{
Name: pulumi.String("my-instance-debug-exclusion"),
Description: pulumi.String("Exclude GCE instance debug logs"),
Filter: pulumi.String("resource.type = gce_instance AND severity <= DEBUG"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
resource "gcp_logging_projectexclusion" "my-exclusion" {
name = "my-instance-debug-exclusion"
description = "Exclude GCE instance debug logs"
filter = "resource.type = gce_instance AND severity <= DEBUG"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.logging.ProjectExclusion;
import com.pulumi.gcp.logging.ProjectExclusionArgs;
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 my_exclusion = new ProjectExclusion("my-exclusion", ProjectExclusionArgs.builder()
.name("my-instance-debug-exclusion")
.description("Exclude GCE instance debug logs")
.filter("resource.type = gce_instance AND severity <= DEBUG")
.build());
}
}
resources:
my-exclusion:
type: gcp:logging:ProjectExclusion
properties:
name: my-instance-debug-exclusion
description: Exclude GCE instance debug logs
filter: resource.type = gce_instance AND severity <= DEBUG
Import
Project-level logging exclusions can be imported using their URI, e.g.
projects/{{project_id}}/exclusions/{{name}}
When using the pulumi import command, project-level logging exclusions can be imported using one of the formats above. For example:
$ pulumi import gcp:logging/projectExclusion:ProjectExclusion default projects/{{project_id}}/exclusions/{{name}}
Constructors
- ProjectExclusion(String name, {ProjectExclusionArgs? args, CustomResourceOptions? options})
-
Creates a new ProjectExclusion.
nameThe Pulumi resource name.argsArguments used to configure this ProjectExclusion. The set of arguments for ProjectExclusion.optionsResource options controlling this resource's behavior. - ProjectExclusion.reference(String urn)
- Creates a typed reference to an existing ProjectExclusion resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String?> -
A human-readable description.
latefinal
-
disabled
↔ Output<
bool?> -
Whether this exclusion rule should be disabled or not. This defaults to
false.
latefinal
-
filter
↔ Output<
String> -
The filter to apply when excluding logs. Only log entries that match the filter are excluded.
See Advanced Log Filters for information on how to
write a filter.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
The name of the logging exclusion.
latefinal
-
project
↔ Output<
String> -
The project to create the exclusion in. If omitted, the project associated with the provider is
used.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
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, {ProjectExclusionState? state, CustomResourceOptions? options}) → ProjectExclusion -
Gets an existing ProjectExclusion resource's state with the given
nameandid.