BillingAccountSink

class BillingAccountSink : KotlinCustomResource

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.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const log_bucket = new gcp.storage.Bucket("log-bucket", {
name: "billing-logging-bucket",
location: "US",
});
const my_sink = new gcp.logging.BillingAccountSink("my-sink", {
name: "my-sink",
description: "some explanation on what this is",
billingAccount: "ABCDEF-012345-GHIJKL",
destination: pulumi.interpolate`storage.googleapis.com/${log_bucket.name}`,
});
const log_writer = new gcp.projects.IAMBinding("log-writer", {
project: "your-project-id",
role: "roles/storage.objectCreator",
members: [my_sink.writerIdentity],
});
import pulumi
import pulumi_gcp as gcp
log_bucket = gcp.storage.Bucket("log-bucket",
name="billing-logging-bucket",
location="US")
my_sink = gcp.logging.BillingAccountSink("my-sink",
name="my-sink",
description="some explanation on what this is",
billing_account="ABCDEF-012345-GHIJKL",
destination=log_bucket.name.apply(lambda name: f"storage.googleapis.com/{name}"))
log_writer = gcp.projects.IAMBinding("log-writer",
project="your-project-id",
role="roles/storage.objectCreator",
members=[my_sink.writer_identity])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var log_bucket = new Gcp.Storage.Bucket("log-bucket", new()
{
Name = "billing-logging-bucket",
Location = "US",
});
var my_sink = new Gcp.Logging.BillingAccountSink("my-sink", new()
{
Name = "my-sink",
Description = "some explanation on what this is",
BillingAccount = "ABCDEF-012345-GHIJKL",
Destination = log_bucket.Name.Apply(name => $"storage.googleapis.com/{name}"),
});
var log_writer = new Gcp.Projects.IAMBinding("log-writer", new()
{
Project = "your-project-id",
Role = "roles/storage.objectCreator",
Members = new[]
{
my_sink.WriterIdentity,
},
});
});
package main
import (
"fmt"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/logging"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/projects"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/storage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
log_bucket, err := storage.NewBucket(ctx, "log-bucket", &storage.BucketArgs{
Name: pulumi.String("billing-logging-bucket"),
Location: pulumi.String("US"),
})
if err != nil {
return err
}
my_sink, err := logging.NewBillingAccountSink(ctx, "my-sink", &logging.BillingAccountSinkArgs{
Name: pulumi.String("my-sink"),
Description: pulumi.String("some explanation on what this is"),
BillingAccount: pulumi.String("ABCDEF-012345-GHIJKL"),
Destination: log_bucket.Name.ApplyT(func(name string) (string, error) {
return fmt.Sprintf("storage.googleapis.com/%v", name), nil
}).(pulumi.StringOutput),
})
if err != nil {
return err
}
_, err = projects.NewIAMBinding(ctx, "log-writer", &projects.IAMBindingArgs{
Project: pulumi.String("your-project-id"),
Role: pulumi.String("roles/storage.objectCreator"),
Members: pulumi.StringArray{
my_sink.WriterIdentity,
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import com.pulumi.gcp.logging.BillingAccountSink;
import com.pulumi.gcp.logging.BillingAccountSinkArgs;
import com.pulumi.gcp.projects.IAMBinding;
import com.pulumi.gcp.projects.IAMBindingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var log_bucket = new Bucket("log-bucket", BucketArgs.builder()
.name("billing-logging-bucket")
.location("US")
.build());
var my_sink = new BillingAccountSink("my-sink", BillingAccountSinkArgs.builder()
.name("my-sink")
.description("some explanation on what this is")
.billingAccount("ABCDEF-012345-GHIJKL")
.destination(log_bucket.name().applyValue(_name -> String.format("storage.googleapis.com/%s", _name)))
.build());
var log_writer = new IAMBinding("log-writer", IAMBindingArgs.builder()
.project("your-project-id")
.role("roles/storage.objectCreator")
.members(my_sink.writerIdentity())
.build());
}
}
resources:
my-sink:
type: gcp:logging:BillingAccountSink
properties:
name: my-sink
description: some explanation on what this is
billingAccount: ABCDEF-012345-GHIJKL
destination: storage.googleapis.com/${["log-bucket"].name}
log-bucket:
type: gcp:storage:Bucket
properties:
name: billing-logging-bucket
location: US
log-writer:
type: gcp:projects:IAMBinding
properties:
project: your-project-id
role: roles/storage.objectCreator
members:
- ${["my-sink"].writerIdentity}

Import

Billing account logging sinks can be imported using this format:

  • billingAccounts/{{billing_account_id}}/sinks/{{sink_id}} When using the pulumi import command, billing account logging sinks can be imported using one of the formats above. For example:

$ pulumi import gcp:logging/billingAccountSink:BillingAccountSink default billingAccounts/{{billing_account_id}}/sinks/{{sink_id}}

Properties

Link copied to clipboard

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

Link copied to clipboard
val billingAccount: Output<String>

The billing account exported to the sink.

Link copied to clipboard
val description: Output<String>?

A description of this sink. The maximum length of the description is 8000 characters.

Link copied to clipboard
val destination: Output<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 or a Cloud Logging bucket. Examples:

Link copied to clipboard
val disabled: Output<Boolean>?

If set to True, then this sink is disabled and it does not export any log entries.

Link copied to clipboard

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.

Link copied to clipboard
val filter: Output<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.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val name: Output<String>

The name of the logging sink.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val writerIdentity: Output<String>

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