FolderSinkArgs class

The set of arguments for FolderSink. The set of arguments for FolderSink.

Constructors

FolderSinkArgs({Input<FolderSinkBigqueryOptions?>? bigqueryOptions, Input<String?>? deletionPolicy, Input<String?>? description, required Input<String> destination, Input<bool?>? disabled, Input<List<FolderSinkExclusion>?>? exclusions, Input<String?>? filter, required Input<String> folder, Input<bool?>? includeChildren, Input<bool?>? interceptChildren, Input<String?>? name})
Creates a new FolderSinkArgs. bigqueryOptions Options that affect sinks exporting data to BigQuery. Structure documented below. 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. folder The folder to be exported to the sink. Note that either [FOLDER_ID] or folders/[FOLDER_ID] is includeChildren Whether or not to include children folders in the sink export. If true, logs interceptChildren Whether or not to intercept logs from child projects. If true, matching logs will not name The name of the logging sink.
const
FolderSinkArgs.fromMap(Map<String, dynamic> map)
factory

Properties

bigqueryOptions → Input<FolderSinkBigqueryOptions?>?
Options that affect sinks exporting data to BigQuery. Structure documented below.
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<FolderSinkExclusion>?>?
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
folder → Input<String>
The folder to be exported to the sink. Note that either [FOLDER_ID] or folders/[FOLDER_ID] is accepted.
final
hashCode → int
The hash code for this object.
no setterinherited
includeChildren → Input<bool?>?
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.
final
interceptChildren → Input<bool?>?
Whether or not to intercept logs from child projects. If true, matching logs will not match with sinks in child resources, except _Required sinks. This sink will be visible to child resources when listing sinks.
final
name → Input<String?>?
The name of the logging sink.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

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