Package com.hashicorp.cdktf.providers.google.logging_organization_sink

Class LoggingOrganizationSink.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static LoggingOrganizationSink.Builder create​(software.constructs.Construct scope,
                                                     String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of LoggingOrganizationSink.Builder.

      • connection

        @Stability(Experimental)
public LoggingOrganizationSink.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public LoggingOrganizationSink.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public LoggingOrganizationSink.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public LoggingOrganizationSink.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public LoggingOrganizationSink.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public LoggingOrganizationSink.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public LoggingOrganizationSink.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • destination

        @Stability(Stable)
public LoggingOrganizationSink.Builder destination​(String 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: "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_organization_sink#destination LoggingOrganizationSink#destination}

        Parameters:
        destination - The destination of the sink (or, in other words, where logs are written to). This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public LoggingOrganizationSink.Builder name​(String name)
        The name of the logging sink.

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

        Parameters:
        name - The name of the logging sink. This parameter is required.
        Returns:
        this

      • orgId

        @Stability(Stable)
public LoggingOrganizationSink.Builder orgId​(String orgId)
        The numeric ID of the organization to be exported to the sink.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_organization_sink#org_id LoggingOrganizationSink#org_id}

        Parameters:
        orgId - The numeric ID of the organization to be exported to the sink. This parameter is required.
        Returns:
        this

      • bigqueryOptions

        @Stability(Stable)
public LoggingOrganizationSink.Builder bigqueryOptions​(LoggingOrganizationSinkBigqueryOptions bigqueryOptions)
        bigquery_options block.

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

        Parameters:
        bigqueryOptions - bigquery_options block. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public LoggingOrganizationSink.Builder description​(String description)
        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_organization_sink#description LoggingOrganizationSink#description}

        Parameters:
        description - A description of this sink. The maximum length of the description is 8000 characters. This parameter is required.
        Returns:
        this

      • disabled

        @Stability(Stable)
public LoggingOrganizationSink.Builder disabled​(Boolean disabled)
        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_organization_sink#disabled LoggingOrganizationSink#disabled}

        Parameters:
        disabled - If set to True, then this sink is disabled and it does not export any log entries. This parameter is required.
        Returns:
        this

      • disabled

        @Stability(Stable)
public LoggingOrganizationSink.Builder disabled​(com.hashicorp.cdktf.IResolvable disabled)
        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_organization_sink#disabled LoggingOrganizationSink#disabled}

        Parameters:
        disabled - If set to True, then this sink is disabled and it does not export any log entries. This parameter is required.
        Returns:
        this

      • exclusions

        @Stability(Stable)
public LoggingOrganizationSink.Builder exclusions​(com.hashicorp.cdktf.IResolvable exclusions)
        exclusions block.

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

        Parameters:
        exclusions - exclusions block. This parameter is required.
        Returns:
        this

      • exclusions

        @Stability(Stable)
public LoggingOrganizationSink.Builder exclusions​(List<? extends LoggingOrganizationSinkExclusions> exclusions)
        exclusions block.

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

        Parameters:
        exclusions - exclusions block. This parameter is required.
        Returns:
        this

      • filter

        @Stability(Stable)
public LoggingOrganizationSink.Builder filter​(String filter)
        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_organization_sink#filter LoggingOrganizationSink#filter}

        Parameters:
        filter - The filter to apply when exporting logs. Only log entries that match the filter are exported. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public LoggingOrganizationSink.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_organization_sink#id LoggingOrganizationSink#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.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_organization_sink#id LoggingOrganizationSink#id}. This parameter is required.
        Returns:
        this

      • includeChildren

        @Stability(Stable)
public LoggingOrganizationSink.Builder includeChildren​(Boolean includeChildren)
        Whether or not to include children organizations in the sink export.

        If true, logs associated with child projects are also exported; otherwise only logs relating to the provided organization are included. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_organization_sink#include_children LoggingOrganizationSink#include_children}

        Parameters:
        includeChildren - Whether or not to include children organizations in the sink export. This parameter is required.
        Returns:
        this

      • includeChildren

        @Stability(Stable)
public LoggingOrganizationSink.Builder includeChildren​(com.hashicorp.cdktf.IResolvable includeChildren)
        Whether or not to include children organizations in the sink export.

        If true, logs associated with child projects are also exported; otherwise only logs relating to the provided organization are included. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_organization_sink#include_children LoggingOrganizationSink#include_children}

        Parameters:
        includeChildren - Whether or not to include children organizations in the sink export. This parameter is required.
        Returns:
        this

      • interceptChildren

        @Stability(Stable)
public LoggingOrganizationSink.Builder interceptChildren​(Boolean interceptChildren)
        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_organization_sink#intercept_children LoggingOrganizationSink#intercept_children}

        Parameters:
        interceptChildren - Whether or not to intercept logs from child projects. This parameter is required.
        Returns:
        this

      • interceptChildren

        @Stability(Stable)
public LoggingOrganizationSink.Builder interceptChildren​(com.hashicorp.cdktf.IResolvable interceptChildren)
        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_organization_sink#intercept_children LoggingOrganizationSink#intercept_children}

        Parameters:
        interceptChildren - Whether or not to intercept logs from child projects. This parameter is required.
        Returns:
        this