Package com.hashicorp.cdktf.providers.google.logging_folder_sink

Interface LoggingFolderSinkConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    LoggingFolderSinkConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:21.824Z")
@Stability(Stable)
public interface LoggingFolderSinkConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getDestination

        @Stability(Stable)
@NotNull
String getDestination()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_folder_sink#destination LoggingFolderSink#destination}

      • getFolder

        @Stability(Stable)
@NotNull
String getFolder()
        The folder to be exported to the sink. Note that either [FOLDER_ID] or "folders/[FOLDER_ID]" is accepted.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_folder_sink#folder LoggingFolderSink#folder}

      • getName

        @Stability(Stable)
@NotNull
String getName()
        The name of the logging sink.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_folder_sink#name LoggingFolderSink#name}

      • getBigqueryOptions

        @Stability(Stable)
@Nullable
default LoggingFolderSinkBigqueryOptions getBigqueryOptions()
        bigquery_options block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_folder_sink#bigquery_options LoggingFolderSink#bigquery_options}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        A description of this sink. The maximum length of the description is 8000 characters.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_folder_sink#description LoggingFolderSink#description}

      • getDisabled

        @Stability(Stable)
@Nullable
default Object getDisabled()
        If set to True, then this sink is disabled and it does not export any log entries.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_folder_sink#disabled LoggingFolderSink#disabled}

      • getExclusions

        @Stability(Stable)
@Nullable
default Object getExclusions()
        exclusions block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_folder_sink#exclusions LoggingFolderSink#exclusions}

      • getFilter

        @Stability(Stable)
@Nullable
default String getFilter()
        The filter to apply when exporting logs. Only log entries that match the filter are exported.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_folder_sink#filter LoggingFolderSink#filter}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_folder_sink#id LoggingFolderSink#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getIncludeChildren

        @Stability(Stable)
@Nullable
default Object getIncludeChildren()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_folder_sink#include_children LoggingFolderSink#include_children}

      • getInterceptChildren

        @Stability(Stable)
@Nullable
default Object getInterceptChildren()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_folder_sink#intercept_children LoggingFolderSink#intercept_children}