Class FolderSink

Manages a folder-level logging sink. For more information see the official documentation and Exporting Logs in the API.

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 log_bucket = new Gcp.Storage.Bucket("log-bucket", new Gcp.Storage.BucketArgs
    {
    });
    var my_folder = new Gcp.Organizations.Folder("my-folder", new Gcp.Organizations.FolderArgs
    {
        DisplayName = "My folder",
        Parent = "organizations/123456",
    });
    var my_sink = new Gcp.Logging.FolderSink("my-sink", new Gcp.Logging.FolderSinkArgs
    {
        Folder = my_folder.Name,
        Destination = log_bucket.Name.Apply(name => $"storage.googleapis.com/{name}"),
        Filter = "resource.type = gce_instance AND severity >= WARN",
    });
    var log_writer = new Gcp.Projects.IAMBinding("log-writer", new Gcp.Projects.IAMBindingArgs
    {
        Role = "roles/storage.objectCreator",
        Members = 
        {
            my_sink.WriterIdentity,
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

FolderSink

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 FolderSink : CustomResource

Constructors

FolderSink(String, FolderSinkArgs, CustomResourceOptions)

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

Declaration

public FolderSink(string name, FolderSinkArgs args, CustomResourceOptions options = null)

Parameters

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

Properties

BigqueryOptions

Options that affect sinks exporting data to BigQuery. Structure documented below.

Declaration

public Output<FolderSinkBigqueryOptions> BigqueryOptions { get; }

Property Value

Type	Description
Output<FolderSinkBigqueryOptions>

Destination

The destination of the sink (or, in other words, where logs are written to). Can be a Cloud Storage bucket, a PubSub topic, or a BigQuery dataset. Examples: "storage.googleapis.com/[GCS_BUCKET]" "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" The writer associated with the sink must have access to write to the above resource.

Declaration

public Output<string> Destination { get; }

Property Value

Type	Description
Output<System.String>

Filter

The filter to apply when exporting logs. Only log entries that match the filter are exported. 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>

IncludeChildren

Whether or not to include children folders in the sink export. If true, logs associated with child projects are also exported; otherwise only logs relating to the provided folder are included.

Declaration

public Output<bool?> IncludeChildren { get; }

Property Value

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

Name

The name of the logging sink.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

WriterIdentity

The identity associated with this sink. This identity must be granted write access to the configured destination.

Declaration

public Output<string> WriterIdentity { get; }

Property Value

Type	Description
Output<System.String>

Methods

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

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

Declaration

public static FolderSink Get(string name, Input<string> id, FolderSinkState 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.
FolderSinkState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
FolderSink