UsageExportBucket class

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")

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 main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_projects_usageexportbucket" "usage_export" {
  project     = "development-project"
  bucket_name = "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.ArrayList;
import java.util.Arrays;
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

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}}

Constructors

UsageExportBucket(String name, {UsageExportBucketArgs? args, CustomResourceOptions? options}): Creates a new UsageExportBucket. name The Pulumi resource name. args Arguments used to configure this UsageExportBucket. The set of arguments for UsageExportBucket. options Resource options controlling this resource's behavior.
UsageExportBucket.reference(String urn): Creates a typed reference to an existing UsageExportBucket resource.

Properties

bucketName ↔ Output<String>: The bucket to store reports in.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
prefix ↔ Output<String?>: A prefix for the reports, for instance, the project name.
latefinal
project ↔ Output<String>: The project to set the export bucket on. If it is not provided, the provider project is used.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {UsageExportBucketState? state, CustomResourceOptions? options}) → UsageExportBucket: Gets an existing UsageExportBucket resource's state with the given name and id.