ProjectSinkState class

Input properties used for looking up and filtering ProjectSink resources.

Constructors

ProjectSinkState({Input<ProjectSinkBigqueryOptions?>? bigqueryOptions, Input<String?>? customWriterIdentity, Input<String?>? deletionPolicy, Input<String?>? description, Input<String?>? destination, Input<bool?>? disabled, Input<List<ProjectSinkExclusion>?>? exclusions, Input<String?>? filter, Input<String?>? name, Input<String?>? project, Input<bool?>? uniqueWriterIdentity, Input<String?>? writerIdentity})
Creates a new ProjectSinkState. bigqueryOptions Options that affect sinks exporting data to BigQuery. Structure documented below. customWriterIdentity A user managed service account that will be used to write deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". description A description of this sink. The maximum length of the description is 8000 characters. destination The destination of the sink (or, in other words, where logs are written to). Can be a Cloud Storage bucket, a PubSub topic, a BigQuery dataset, a Cloud Logging bucket, or a Google Cloud project. Examples: disabled If set to True, then this sink is disabled and it does not export any log entries. exclusions Log entries that match any of the exclusion filters will not be exported. If a log entry is matched by both filter and one of exclusions.filter, it will not be exported. Can be repeated multiple times for multiple exclusions. Structure is documented below. filter The filter to apply when exporting logs. Only log entries that match the filter are exported. name The name of the logging sink. Logging automatically creates two sinks: _Required and _Default. project The ID of the project to create the sink in. If omitted, the project associated with the provider is uniqueWriterIdentity Whether to use a service agent as the writerIdentity for this sink. If false, writerIdentity The identity associated with this sink. This identity must be granted write access to the
const
ProjectSinkState.fromMap(Map<String, dynamic> map)
factory

Properties

bigqueryOptions → Input<ProjectSinkBigqueryOptions?>?
Options that affect sinks exporting data to BigQuery. Structure documented below.
final
customWriterIdentity → Input<String?>?
A user managed service account that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified if you are routing logs to a destination outside this sink's project. If not specified, a Logging service account will automatically be generated.
final
deletionPolicy → Input<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.
final
description → Input<String?>?
A description of this sink. The maximum length of the description is 8000 characters.
final
destination → Input<String?>?
The destination of the sink (or, in other words, where logs are written to). Can be a Cloud Storage bucket, a PubSub topic, a BigQuery dataset, a Cloud Logging bucket, or a Google Cloud project. Examples:
final
disabled → Input<bool?>?
If set to True, then this sink is disabled and it does not export any log entries.
final
exclusions → Input<List<ProjectSinkExclusion>?>?
Log entries that match any of the exclusion filters will not be exported. If a log entry is matched by both filter and one of exclusions.filter, it will not be exported. Can be repeated multiple times for multiple exclusions. Structure is documented below.
final
filter → Input<String?>?
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.
final
hashCode → int
The hash code for this object.
no setterinherited
name → Input<String?>?
The name of the logging sink. Logging automatically creates two sinks: _Required and _Default.
final
project → Input<String?>?
The ID of the project to create the sink in. If omitted, the project associated with the provider is used.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
uniqueWriterIdentity → Input<bool?>?
Whether to use a service agent as the writerIdentity for this sink. If false, writerIdentity is serviceAccount:cloud-logs@system.gserviceaccount.com and the sink's destination must be in the same project as the sink. If true (the default), writerIdentity is a service agent shared by sinks with the same parent. You must set uniqueWriterIdentity to true to publish logs across projects or use bigqueryOptions. See the projects.sinks.create API documentation for more information.
final
writerIdentity → Input<String?>?
The identity associated with this sink. This identity must be granted write access to the configured destination.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited