Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. projects
  5. UsageExportBucket
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.projects.UsageExportBucket

Explore with Pulumi AI

gcp logo
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

    Sets up a usage export bucket for a particular project. A usage export bucket is a pre-configured GCS bucket which is set up to receive daily and monthly reports of the GCE resources used.

    For more information see the Docs and for further details, the API Documentation.

    Note: You should specify only one of these per project. If there are two or more they will fight over which bucket the reports should be stored in. It is safe to have multiple resources with the same backing bucket.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const usageExport = new gcp.projects.UsageExportBucket("usage_export", {
    project: "development-project",
    bucketName: "usage-tracking-bucket",
});

    import pulumi
import pulumi_gcp as gcp

usage_export = gcp.projects.UsageExportBucket("usage_export",
    project="development-project",
    bucket_name="usage-tracking-bucket")

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/projects"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := projects.NewUsageExportBucket(ctx, "usage_export", &projects.UsageExportBucketArgs{
			Project:    pulumi.String("development-project"),
			BucketName: pulumi.String("usage-tracking-bucket"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var usageExport = new Gcp.Projects.UsageExportBucket("usage_export", new()
    {
        Project = "development-project",
        BucketName = "usage-tracking-bucket",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.projects.UsageExportBucket;
import com.pulumi.gcp.projects.UsageExportBucketArgs;
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 usageExport = new UsageExportBucket("usageExport", UsageExportBucketArgs.builder()
            .project("development-project")
            .bucketName("usage-tracking-bucket")
            .build());

    }
}

    resources:
  usageExport:
    type: gcp:projects:UsageExportBucket
    name: usage_export
    properties:
      project: development-project
      bucketName: usage-tracking-bucket

    Create UsageExportBucket Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UsageExportBucket(name: string, args: UsageExportBucketArgs, opts?: CustomResourceOptions);
    @overload
def UsageExportBucket(resource_name: str,
                      args: UsageExportBucketArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def UsageExportBucket(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      bucket_name: Optional[str] = None,
                      prefix: Optional[str] = None,
                      project: Optional[str] = None)
    func NewUsageExportBucket(ctx *Context, name string, args UsageExportBucketArgs, opts ...ResourceOption) (*UsageExportBucket, error)
    public UsageExportBucket(string name, UsageExportBucketArgs args, CustomResourceOptions? opts = null)
    public UsageExportBucket(String name, UsageExportBucketArgs args)
public UsageExportBucket(String name, UsageExportBucketArgs args, CustomResourceOptions options)

    type: gcp:projects:UsageExportBucket
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args UsageExportBucketArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UsageExportBucketArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UsageExportBucketArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UsageExportBucketArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UsageExportBucketArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var usageExportBucketResource = new Gcp.Projects.UsageExportBucket("usageExportBucketResource", new()
{
    BucketName = "string",
    Prefix = "string",
    Project = "string",
});

    example, err := projects.NewUsageExportBucket(ctx, "usageExportBucketResource", &projects.UsageExportBucketArgs{
	BucketName: pulumi.String("string"),
	Prefix:     pulumi.String("string"),
	Project:    pulumi.String("string"),
})

    var usageExportBucketResource = new UsageExportBucket("usageExportBucketResource", UsageExportBucketArgs.builder()
    .bucketName("string")
    .prefix("string")
    .project("string")
    .build());

    usage_export_bucket_resource = gcp.projects.UsageExportBucket("usageExportBucketResource",
    bucket_name="string",
    prefix="string",
    project="string")

    const usageExportBucketResource = new gcp.projects.UsageExportBucket("usageExportBucketResource", {
    bucketName: "string",
    prefix: "string",
    project: "string",
});

    type: gcp:projects:UsageExportBucket
properties:
    bucketName: string
    prefix: string
    project: string

    UsageExportBucket Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The UsageExportBucket resource accepts the following input properties:

    BucketName string
    The bucket to store reports in.

    Prefix string
    A prefix for the reports, for instance, the project name.
    Project string
    The project to set the export bucket on. If it is not provided, the provider project is used.
    BucketName string
    The bucket to store reports in.

    Prefix string
    A prefix for the reports, for instance, the project name.
    Project string
    The project to set the export bucket on. If it is not provided, the provider project is used.
    bucketName String
    The bucket to store reports in.

    prefix String
    A prefix for the reports, for instance, the project name.
    project String
    The project to set the export bucket on. If it is not provided, the provider project is used.
    bucketName string
    The bucket to store reports in.

    prefix string
    A prefix for the reports, for instance, the project name.
    project string
    The project to set the export bucket on. If it is not provided, the provider project is used.
    bucket_name str
    The bucket to store reports in.

    prefix str
    A prefix for the reports, for instance, the project name.
    project str
    The project to set the export bucket on. If it is not provided, the provider project is used.
    bucketName String
    The bucket to store reports in.

    prefix String
    A prefix for the reports, for instance, the project name.
    project String
    The project to set the export bucket on. If it is not provided, the provider project is used.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing UsageExportBucket Resource

    Get an existing UsageExportBucket 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?: UsageExportBucketState, opts?: CustomResourceOptions): UsageExportBucket
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bucket_name: Optional[str] = None,
        prefix: Optional[str] = None,
        project: Optional[str] = None) -> UsageExportBucket
    func GetUsageExportBucket(ctx *Context, name string, id IDInput, state *UsageExportBucketState, opts ...ResourceOption) (*UsageExportBucket, error)
    public static UsageExportBucket Get(string name, Input<string> id, UsageExportBucketState? state, CustomResourceOptions? opts = null)
    public static UsageExportBucket get(String name, Output<String> id, UsageExportBucketState state, CustomResourceOptions options)
    resources:  _:    type: gcp:projects:UsageExportBucket    get:      id: ${id}
    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.
    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:
    BucketName string
    The bucket to store reports in.

    Prefix string
    A prefix for the reports, for instance, the project name.
    Project string
    The project to set the export bucket on. If it is not provided, the provider project is used.
    BucketName string
    The bucket to store reports in.

    Prefix string
    A prefix for the reports, for instance, the project name.
    Project string
    The project to set the export bucket on. If it is not provided, the provider project is used.
    bucketName String
    The bucket to store reports in.

    prefix String
    A prefix for the reports, for instance, the project name.
    project String
    The project to set the export bucket on. If it is not provided, the provider project is used.
    bucketName string
    The bucket to store reports in.

    prefix string
    A prefix for the reports, for instance, the project name.
    project string
    The project to set the export bucket on. If it is not provided, the provider project is used.
    bucket_name str
    The bucket to store reports in.

    prefix str
    A prefix for the reports, for instance, the project name.
    project str
    The project to set the export bucket on. If it is not provided, the provider project is used.
    bucketName String
    The bucket to store reports in.

    prefix String
    A prefix for the reports, for instance, the project name.
    project String
    The project to set the export bucket on. If it is not provided, the provider project is used.

    Import

    A project’s Usage Export Bucket can be imported using this format:

    • {{project_id}}

    When using the pulumi import command, NAME_HERE can be imported using one of the formats above. For example:

    $ pulumi import gcp:projects/usageExportBucket:UsageExportBucket default {{project_id}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
    pulumi/pulumi-gcp