Class ProjectSink

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

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

Note You must enable the Cloud Resource Manager API

Inheritance

System.Object

Resource

CustomResource

ProjectSink

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

Constructors

ProjectSink(String, ProjectSinkArgs, CustomResourceOptions)

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

Declaration

public ProjectSink(string name, ProjectSinkArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ProjectSinkArgs	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<ProjectSinkBigqueryOptions> BigqueryOptions { get; }

Property Value

Type	Description
Output<ProjectSinkBigqueryOptions>

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:

using Pulumi;

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>

Name

The name of the logging sink.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Project

The ID of the project to create the sink in. If omitted, the project associated with the provider is used.

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

UniqueWriterIdentity

Whether or not to create a unique identity associated with this sink. If false (the default), then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true, then a unique service account is created and used for this sink. If you wish to publish logs across projects, you must set unique_writer_identity to true.

Declaration

public Output<bool?> UniqueWriterIdentity { get; }

Property Value

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

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>, ProjectSinkState, CustomResourceOptions)

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

Declaration

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

Returns

Type	Description
ProjectSink