Package com.hashicorp.cdktf.providers.google.logging_project_sink

Interface LoggingProjectSinkConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    LoggingProjectSinkConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:21.875Z")
@Stability(Stable)
public interface LoggingProjectSinkConfig
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_project_sink#destination LoggingProjectSink#destination}

      • 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_project_sink#name LoggingProjectSink#name}

      • getBigqueryOptions

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

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

      • getCustomWriterIdentity

        @Stability(Stable)
@Nullable
default String getCustomWriterIdentity()
        A service account provided by the caller 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_project_sink#custom_writer_identity LoggingProjectSink#custom_writer_identity}

      • 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_project_sink#description LoggingProjectSink#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_project_sink#disabled LoggingProjectSink#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_project_sink#exclusions LoggingProjectSink#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_project_sink#filter LoggingProjectSink#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_project_sink#id LoggingProjectSink#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.

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        The ID of the project to create the sink in.

        If omitted, the project associated with the provider is used. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_project_sink#project LoggingProjectSink#project}

      • getUniqueWriterIdentity

        @Stability(Stable)
@Nullable
default Object getUniqueWriterIdentity()
        Whether or not to create a unique identity associated with this sink.

        If false (the legacy behavior), then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true (default), 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_project_sink#unique_writer_identity LoggingProjectSink#unique_writer_identity}