Google Cloud (GCP) Classic

Pulumi Official
Package maintained by Pulumi
v6.24.0 published on Tuesday, May 17, 2022 by Pulumi

BillingAccountBucketConfig

Manages a billing account level logging bucket config. For more information see the official logging documentation and Storing Logs.

Note: Logging buckets are automatically created for a given folder, project, organization, billingAccount and cannot be deleted. Creating a resource of this type will acquire and update the resource that already exists at the desired location. These buckets cannot be removed so deleting this resource will remove the bucket config from your state but will leave the logging bucket unchanged. The buckets that are currently automatically created are “_Default” and “_Required”.

Example Usage

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
    public MyStack()
    {
        var @default = Output.Create(Gcp.Organizations.GetBillingAccount.InvokeAsync(new Gcp.Organizations.GetBillingAccountArgs
        {
            BillingAccount = "00AA00-000AAA-00AA0A",
        }));
        var basic = new Gcp.Logging.BillingAccountBucketConfig("basic", new Gcp.Logging.BillingAccountBucketConfigArgs
        {
            BillingAccount = @default.Apply(@default => @default.BillingAccount),
            Location = "global",
            RetentionDays = 30,
            BucketId = "_Default",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/logging"
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := organizations.GetBillingAccount(ctx, &organizations.GetBillingAccountArgs{
			BillingAccount: pulumi.StringRef("00AA00-000AAA-00AA0A"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = logging.NewBillingAccountBucketConfig(ctx, "basic", &logging.BillingAccountBucketConfigArgs{
			BillingAccount: pulumi.String(_default.BillingAccount),
			Location:       pulumi.String("global"),
			RetentionDays:  pulumi.Int(30),
			BucketId:       pulumi.String("_Default"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var default = Output.of(OrganizationsFunctions.getBillingAccount(GetBillingAccountArgs.builder()
            .billingAccount("00AA00-000AAA-00AA0A")
            .build()));

        var basic = new BillingAccountBucketConfig("basic", BillingAccountBucketConfigArgs.builder()        
            .billingAccount(default_.getBillingAccount())
            .location("global")
            .retentionDays(30)
            .bucketId("_Default")
            .build());

        }
}
import pulumi
import pulumi_gcp as gcp

default = gcp.organizations.get_billing_account(billing_account="00AA00-000AAA-00AA0A")
basic = gcp.logging.BillingAccountBucketConfig("basic",
    billing_account=default.billing_account,
    location="global",
    retention_days=30,
    bucket_id="_Default")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const default = gcp.organizations.getBillingAccount({
    billingAccount: "00AA00-000AAA-00AA0A",
});
const basic = new gcp.logging.BillingAccountBucketConfig("basic", {
    billingAccount: _default.then(_default => _default.billingAccount),
    location: "global",
    retentionDays: 30,
    bucketId: "_Default",
});
resources:
  basic:
    type: gcp:logging:BillingAccountBucketConfig
    properties:
      billingAccount: ${default.billingAccount}
      location: global
      retentionDays: 30
      bucketId: _Default
variables:
  default:
    Fn::Invoke:
      Function: gcp:organizations:getBillingAccount
      Arguments:
        billingAccount: 00AA00-000AAA-00AA0A

Create a BillingAccountBucketConfig Resource

new BillingAccountBucketConfig(name: string, args: BillingAccountBucketConfigArgs, opts?: CustomResourceOptions);
@overload
def BillingAccountBucketConfig(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               billing_account: Optional[str] = None,
                               bucket_id: Optional[str] = None,
                               description: Optional[str] = None,
                               location: Optional[str] = None,
                               retention_days: Optional[int] = None)
@overload
def BillingAccountBucketConfig(resource_name: str,
                               args: BillingAccountBucketConfigArgs,
                               opts: Optional[ResourceOptions] = None)
func NewBillingAccountBucketConfig(ctx *Context, name string, args BillingAccountBucketConfigArgs, opts ...ResourceOption) (*BillingAccountBucketConfig, error)
public BillingAccountBucketConfig(string name, BillingAccountBucketConfigArgs args, CustomResourceOptions? opts = null)
public BillingAccountBucketConfig(String name, BillingAccountBucketConfigArgs args)
public BillingAccountBucketConfig(String name, BillingAccountBucketConfigArgs args, CustomResourceOptions options)
type: gcp:logging:BillingAccountBucketConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args BillingAccountBucketConfigArgs
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 BillingAccountBucketConfigArgs
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 BillingAccountBucketConfigArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BillingAccountBucketConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BillingAccountBucketConfigArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

BillingAccountBucketConfig Resource Properties

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

Inputs

The BillingAccountBucketConfig resource accepts the following input properties:

BillingAccount string

The parent resource that contains the logging bucket.

BucketId string

The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.

Location string

The location of the bucket.

Description string

Describes this bucket.

RetentionDays int

Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. Bucket retention can not be increased on buckets outside of projects.

BillingAccount string

The parent resource that contains the logging bucket.

BucketId string

The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.

Location string

The location of the bucket.

Description string

Describes this bucket.

RetentionDays int

Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. Bucket retention can not be increased on buckets outside of projects.

billingAccount String

The parent resource that contains the logging bucket.

bucketId String

The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.

location String

The location of the bucket.

description String

Describes this bucket.

retentionDays Integer

Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. Bucket retention can not be increased on buckets outside of projects.

billingAccount string

The parent resource that contains the logging bucket.

bucketId string

The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.

location string

The location of the bucket.

description string

Describes this bucket.

retentionDays number

Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. Bucket retention can not be increased on buckets outside of projects.

billing_account str

The parent resource that contains the logging bucket.

bucket_id str

The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.

location str

The location of the bucket.

description str

Describes this bucket.

retention_days int

Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. Bucket retention can not be increased on buckets outside of projects.

billingAccount String

The parent resource that contains the logging bucket.

bucketId String

The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.

location String

The location of the bucket.

description String

Describes this bucket.

retentionDays Number

Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. Bucket retention can not be increased on buckets outside of projects.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

LifecycleState string

The bucket's lifecycle such as active or deleted. See LifecycleState.

Name string

The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id"

Id string

The provider-assigned unique ID for this managed resource.

LifecycleState string

The bucket's lifecycle such as active or deleted. See LifecycleState.

Name string

The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id"

id String

The provider-assigned unique ID for this managed resource.

lifecycleState String

The bucket's lifecycle such as active or deleted. See LifecycleState.

name String

The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id"

id string

The provider-assigned unique ID for this managed resource.

lifecycleState string

The bucket's lifecycle such as active or deleted. See LifecycleState.

name string

The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id"

id str

The provider-assigned unique ID for this managed resource.

lifecycle_state str

The bucket's lifecycle such as active or deleted. See LifecycleState.

name str

The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id"

id String

The provider-assigned unique ID for this managed resource.

lifecycleState String

The bucket's lifecycle such as active or deleted. See LifecycleState.

name String

The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id"

Look up an Existing BillingAccountBucketConfig Resource

Get an existing BillingAccountBucketConfig 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?: BillingAccountBucketConfigState, opts?: CustomResourceOptions): BillingAccountBucketConfig
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        billing_account: Optional[str] = None,
        bucket_id: Optional[str] = None,
        description: Optional[str] = None,
        lifecycle_state: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        retention_days: Optional[int] = None) -> BillingAccountBucketConfig
func GetBillingAccountBucketConfig(ctx *Context, name string, id IDInput, state *BillingAccountBucketConfigState, opts ...ResourceOption) (*BillingAccountBucketConfig, error)
public static BillingAccountBucketConfig Get(string name, Input<string> id, BillingAccountBucketConfigState? state, CustomResourceOptions? opts = null)
public static BillingAccountBucketConfig get(String name, Output<String> id, BillingAccountBucketConfigState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
BillingAccount string

The parent resource that contains the logging bucket.

BucketId string

The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.

Description string

Describes this bucket.

LifecycleState string

The bucket's lifecycle such as active or deleted. See LifecycleState.

Location string

The location of the bucket.

Name string

The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id"

RetentionDays int

Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. Bucket retention can not be increased on buckets outside of projects.

BillingAccount string

The parent resource that contains the logging bucket.

BucketId string

The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.

Description string

Describes this bucket.

LifecycleState string

The bucket's lifecycle such as active or deleted. See LifecycleState.

Location string

The location of the bucket.

Name string

The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id"

RetentionDays int

Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. Bucket retention can not be increased on buckets outside of projects.

billingAccount String

The parent resource that contains the logging bucket.

bucketId String

The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.

description String

Describes this bucket.

lifecycleState String

The bucket's lifecycle such as active or deleted. See LifecycleState.

location String

The location of the bucket.

name String

The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id"

retentionDays Integer

Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. Bucket retention can not be increased on buckets outside of projects.

billingAccount string

The parent resource that contains the logging bucket.

bucketId string

The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.

description string

Describes this bucket.

lifecycleState string

The bucket's lifecycle such as active or deleted. See LifecycleState.

location string

The location of the bucket.

name string

The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id"

retentionDays number

Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. Bucket retention can not be increased on buckets outside of projects.

billing_account str

The parent resource that contains the logging bucket.

bucket_id str

The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.

description str

Describes this bucket.

lifecycle_state str

The bucket's lifecycle such as active or deleted. See LifecycleState.

location str

The location of the bucket.

name str

The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id"

retention_days int

Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. Bucket retention can not be increased on buckets outside of projects.

billingAccount String

The parent resource that contains the logging bucket.

bucketId String

The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.

description String

Describes this bucket.

lifecycleState String

The bucket's lifecycle such as active or deleted. See LifecycleState.

location String

The location of the bucket.

name String

The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id"

retentionDays Number

Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. Bucket retention can not be increased on buckets outside of projects.

Import

This resource can be imported using the following format

 $ pulumi import gcp:logging/billingAccountBucketConfig:BillingAccountBucketConfig default billingAccounts/{{billingAccount}}/locations/{{location}}/buckets/{{bucket_id}}

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.