1. Docs
  2. Reference
  3. API
  4. GCP
  5. logging
  6. BillingAccountSink

BillingAccountSink

Manages a billing account logging sink. For more information see the official documentation and Exporting Logs in the API.

Note You must have the “Logs Configuration Writer” IAM role (roles/logging.configWriter) granted on the billing account to the credentials used with this provider. IAM roles granted on a billing account are separate from the typical IAM roles granted on a project.

Create a BillingAccountSink Resource

new BillingAccountSink(name: string, args: BillingAccountSinkArgs, opts?: CustomResourceOptions);
def BillingAccountSink(resource_name, opts=None, bigquery_options=None, billing_account=None, destination=None, filter=None, name=None, __props__=None);
func NewBillingAccountSink(ctx *Context, name string, args BillingAccountSinkArgs, opts ...ResourceOption) (*BillingAccountSink, error)
public BillingAccountSink(string name, BillingAccountSinkArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args BillingAccountSinkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args BillingAccountSinkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BillingAccountSinkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

BillingAccountSink Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The BillingAccountSink resource accepts the following input properties:

BillingAccount string

The billing account exported to the sink.

Destination string

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:

import * as pulumi from "@pulumi/pulumi";
import pulumi
using Pulumi;

class MyStack : Stack
{
    public MyStack()
    {
    }

}

package main

import (
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        return nil
    })
}

The writer associated with the sink must have access to write to the above resource.

BigqueryOptions BillingAccountSinkBigqueryOptionsArgs

Options that affect sinks exporting data to BigQuery. Structure documented below.

Filter 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.

Name string

The name of the logging sink.

BillingAccount string

The billing account exported to the sink.

Destination string

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:

import * as pulumi from "@pulumi/pulumi";
import pulumi
using Pulumi;

class MyStack : Stack
{
    public MyStack()
    {
    }

}

package main

import (
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        return nil
    })
}

The writer associated with the sink must have access to write to the above resource.

BigqueryOptions BillingAccountSinkBigqueryOptions

Options that affect sinks exporting data to BigQuery. Structure documented below.

Filter 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.

Name string

The name of the logging sink.

billingAccount string

The billing account exported to the sink.

destination string

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:

import * as pulumi from "@pulumi/pulumi";
import pulumi
using Pulumi;

class MyStack : Stack
{
    public MyStack()
    {
    }

}

package main

import (
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        return nil
    })
}

The writer associated with the sink must have access to write to the above resource.

bigqueryOptions BillingAccountSinkBigqueryOptions

Options that affect sinks exporting data to BigQuery. Structure documented below.

filter 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.

name string

The name of the logging sink.

billing_account str

The billing account exported to the sink.

destination str

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:

import * as pulumi from "@pulumi/pulumi";
import pulumi
using Pulumi;

class MyStack : Stack
{
    public MyStack()
    {
    }

}

package main

import (
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        return nil
    })
}

The writer associated with the sink must have access to write to the above resource.

bigquery_options Dict[BillingAccountSinkBigqueryOptions]

Options that affect sinks exporting data to BigQuery. Structure documented below.

filter str

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.

name str

The name of the logging sink.

Outputs

All input properties are implicitly available as output properties. Additionally, the BillingAccountSink resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
WriterIdentity string

The identity associated with this sink. This identity must be granted write access to the configured destination.

Id string
The provider-assigned unique ID for this managed resource.
WriterIdentity string

The identity associated with this sink. This identity must be granted write access to the configured destination.

id string
The provider-assigned unique ID for this managed resource.
writerIdentity string

The identity associated with this sink. This identity must be granted write access to the configured destination.

id str
The provider-assigned unique ID for this managed resource.
writer_identity str

The identity associated with this sink. This identity must be granted write access to the configured destination.

Look up an Existing BillingAccountSink Resource

Get an existing BillingAccountSink resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BillingAccountSinkState, opts?: CustomResourceOptions): BillingAccountSink
static get(resource_name, id, opts=None, bigquery_options=None, billing_account=None, destination=None, filter=None, name=None, writer_identity=None, __props__=None);
func GetBillingAccountSink(ctx *Context, name string, id IDInput, state *BillingAccountSinkState, opts ...ResourceOption) (*BillingAccountSink, error)
public static BillingAccountSink Get(string name, Input<string> id, BillingAccountSinkState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

BigqueryOptions BillingAccountSinkBigqueryOptionsArgs

Options that affect sinks exporting data to BigQuery. Structure documented below.

BillingAccount string

The billing account exported to the sink.

Destination string

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:

import * as pulumi from "@pulumi/pulumi";
import pulumi
using Pulumi;

class MyStack : Stack
{
    public MyStack()
    {
    }

}

package main

import (
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        return nil
    })
}

The writer associated with the sink must have access to write to the above resource.

Filter 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.

Name string

The name of the logging sink.

WriterIdentity string

The identity associated with this sink. This identity must be granted write access to the configured destination.

BigqueryOptions BillingAccountSinkBigqueryOptions

Options that affect sinks exporting data to BigQuery. Structure documented below.

BillingAccount string

The billing account exported to the sink.

Destination string

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:

import * as pulumi from "@pulumi/pulumi";
import pulumi
using Pulumi;

class MyStack : Stack
{
    public MyStack()
    {
    }

}

package main

import (
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        return nil
    })
}

The writer associated with the sink must have access to write to the above resource.

Filter 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.

Name string

The name of the logging sink.

WriterIdentity string

The identity associated with this sink. This identity must be granted write access to the configured destination.

bigqueryOptions BillingAccountSinkBigqueryOptions

Options that affect sinks exporting data to BigQuery. Structure documented below.

billingAccount string

The billing account exported to the sink.

destination string

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:

import * as pulumi from "@pulumi/pulumi";
import pulumi
using Pulumi;

class MyStack : Stack
{
    public MyStack()
    {
    }

}

package main

import (
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        return nil
    })
}

The writer associated with the sink must have access to write to the above resource.

filter 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.

name string

The name of the logging sink.

writerIdentity string

The identity associated with this sink. This identity must be granted write access to the configured destination.

bigquery_options Dict[BillingAccountSinkBigqueryOptions]

Options that affect sinks exporting data to BigQuery. Structure documented below.

billing_account str

The billing account exported to the sink.

destination str

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:

import * as pulumi from "@pulumi/pulumi";
import pulumi
using Pulumi;

class MyStack : Stack
{
    public MyStack()
    {
    }

}

package main

import (
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        return nil
    })
}

The writer associated with the sink must have access to write to the above resource.

filter str

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.

name str

The name of the logging sink.

writer_identity str

The identity associated with this sink. This identity must be granted write access to the configured destination.

Supporting Types

BillingAccountSinkBigqueryOptions

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

UsePartitionedTables bool

Whether to use BigQuery’s partition tables. By default, Logging creates dated tables based on the log entries’ timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.

UsePartitionedTables bool

Whether to use BigQuery’s partition tables. By default, Logging creates dated tables based on the log entries’ timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.

usePartitionedTables boolean

Whether to use BigQuery’s partition tables. By default, Logging creates dated tables based on the log entries’ timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.

usePartitionedTables bool

Whether to use BigQuery’s partition tables. By default, Logging creates dated tables based on the log entries’ timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.