Class FolderExclusion

Manages a folder-level logging exclusion. For more information see the official documentation and Excluding Logs.

Note that you must have the "Logs Configuration Writer" IAM role (roles/logging.configWriter) granted to the credentials used with this provider.

Example Usage

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var my_folder = new Gcp.Organizations.Folder("my-folder", new Gcp.Organizations.FolderArgs
    {
        DisplayName = "My folder",
        Parent = "organizations/123456",
    });
    var my_exclusion = new Gcp.Logging.FolderExclusion("my-exclusion", new Gcp.Logging.FolderExclusionArgs
    {
        Folder = my_folder.Name,
        Description = "Exclude GCE instance debug logs",
        Filter = "resource.type = gce_instance AND severity <= DEBUG",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

FolderExclusion

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.Logging

Assembly: Pulumi.Gcp.dll

Syntax

public class FolderExclusion : CustomResource

Constructors

FolderExclusion(String, FolderExclusionArgs, CustomResourceOptions)

Create a FolderExclusion resource with the given unique name, arguments, and options.

Declaration

public FolderExclusion(string name, FolderExclusionArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
FolderExclusionArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Description

A human-readable description.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Disabled

Whether this exclusion rule should be disabled or not. This defaults to false.

Declaration

public Output<bool?> Disabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Filter

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.

Declaration

public Output<string> Filter { get; }

Property Value

Type	Description
Output<System.String>

Folder

The folder to be exported to the sink. Note that either [FOLDER_ID] or "folders/[FOLDER_ID]" is accepted.

Declaration

public Output<string> Folder { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the logging exclusion.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, FolderExclusionState, CustomResourceOptions)

Get an existing FolderExclusion resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static FolderExclusion Get(string name, Input<string> id, FolderExclusionState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
FolderExclusionState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
FolderExclusion