← All packages

Google Cloud (GCP) Classic

Pulumi Official
Package maintained by Pulumi
v6.24.0 published on Tuesday, May 17, 2022 by Pulumi
Source code
  1. Pulumi Registry
  2. Google Cloud (GCP) Classic
  3. Google Cloud Classic
  4. logging
  5. FolderBucketConfig

FolderBucketConfig

Manages a folder-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 = new Gcp.Organizations.Folder("default", new Gcp.Organizations.FolderArgs
        {
            DisplayName = "some-folder-name",
            Parent = "organizations/123456789",
        });
        var basic = new Gcp.Logging.FolderBucketConfig("basic", new Gcp.Logging.FolderBucketConfigArgs
        {
            Folder = @default.Name,
            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 {
		_, err := organizations.NewFolder(ctx, "default", &organizations.FolderArgs{
			DisplayName: pulumi.String("some-folder-name"),
			Parent:      pulumi.String("organizations/123456789"),
		})
		if err != nil {
			return err
		}
		_, err = logging.NewFolderBucketConfig(ctx, "basic", &logging.FolderBucketConfigArgs{
			Folder:        _default.Name,
			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) {
        var default_ = new Folder("default", FolderArgs.builder()        
            .displayName("some-folder-name")
            .parent("organizations/123456789")
            .build());

        var basic = new FolderBucketConfig("basic", FolderBucketConfigArgs.builder()        
            .folder(default_.getName())
            .location("global")
            .retentionDays(30)
            .bucketId("_Default")
            .build());

        }
}

import pulumi
import pulumi_gcp as gcp

default = gcp.organizations.Folder("default",
    display_name="some-folder-name",
    parent="organizations/123456789")
basic = gcp.logging.FolderBucketConfig("basic",
    folder=default.name,
    location="global",
    retention_days=30,
    bucket_id="_Default")

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

const _default = new gcp.organizations.Folder("default", {
    displayName: "some-folder-name",
    parent: "organizations/123456789",
});
const basic = new gcp.logging.FolderBucketConfig("basic", {
    folder: _default.name,
    location: "global",
    retentionDays: 30,
    bucketId: "_Default",
});

resources:
  default:
    type: gcp:organizations:Folder
    properties:
      displayName: some-folder-name
      parent: organizations/123456789
  basic:
    type: gcp:logging:FolderBucketConfig
    properties:
      folder: ${default.name}
      location: global
      retentionDays: 30
      bucketId: _Default

Create a FolderBucketConfig Resource

new FolderBucketConfig(name: string, args: FolderBucketConfigArgs, opts?: CustomResourceOptions);
@overload
def FolderBucketConfig(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       bucket_id: Optional[str] = None,
                       description: Optional[str] = None,
                       folder: Optional[str] = None,
                       location: Optional[str] = None,
                       retention_days: Optional[int] = None)
@overload
def FolderBucketConfig(resource_name: str,
                       args: FolderBucketConfigArgs,
                       opts: Optional[ResourceOptions] = None)
func NewFolderBucketConfig(ctx *Context, name string, args FolderBucketConfigArgs, opts ...ResourceOption) (*FolderBucketConfig, error)
public FolderBucketConfig(string name, FolderBucketConfigArgs args, CustomResourceOptions? opts = null)
public FolderBucketConfig(String name, FolderBucketConfigArgs args)
public FolderBucketConfig(String name, FolderBucketConfigArgs args, CustomResourceOptions options)

type: gcp:logging:FolderBucketConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FolderBucketConfigArgs
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 FolderBucketConfigArgs
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 FolderBucketConfigArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FolderBucketConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args FolderBucketConfigArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

FolderBucketConfig 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 FolderBucketConfig resource accepts the following input properties:

BucketId string

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

Folder string

The parent resource that contains the logging bucket.

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.

BucketId string

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

Folder string

The parent resource that contains the logging bucket.

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.

bucketId String

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

folder String

The parent resource that contains the logging bucket.

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.

bucketId string

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

folder string

The parent resource that contains the logging bucket.

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.

bucket_id str

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

folder str

The parent resource that contains the logging bucket.

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.

bucketId String

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

folder String

The parent resource that contains the logging bucket.

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 FolderBucketConfig 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: "folders/my-folder-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: "folders/my-folder-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: "folders/my-folder-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: "folders/my-folder-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: "folders/my-folder-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: "folders/my-folder-id/locations/my-location/buckets/my-bucket-id"

Look up an Existing FolderBucketConfig Resource

Get an existing FolderBucketConfig 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?: FolderBucketConfigState, opts?: CustomResourceOptions): FolderBucketConfig
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bucket_id: Optional[str] = None,
        description: Optional[str] = None,
        folder: Optional[str] = None,
        lifecycle_state: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        retention_days: Optional[int] = None) -> FolderBucketConfig
func GetFolderBucketConfig(ctx *Context, name string, id IDInput, state *FolderBucketConfigState, opts ...ResourceOption) (*FolderBucketConfig, error)
public static FolderBucketConfig Get(string name, Input<string> id, FolderBucketConfigState? state, CustomResourceOptions? opts = null)
public static FolderBucketConfig get(String name, Output<String> id, FolderBucketConfigState 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:
BucketId string

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

Description string

Describes this bucket.

Folder string

The parent resource that contains the logging 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: "folders/my-folder-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.

BucketId string

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

Description string

Describes this bucket.

Folder string

The parent resource that contains the logging 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: "folders/my-folder-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.

bucketId String

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

description String

Describes this bucket.

folder String

The parent resource that contains the logging 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: "folders/my-folder-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.

bucketId string

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

description string

Describes this bucket.

folder string

The parent resource that contains the logging 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: "folders/my-folder-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.

bucket_id str

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

description str

Describes this bucket.

folder str

The parent resource that contains the logging 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: "folders/my-folder-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.

bucketId String

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

description String

Describes this bucket.

folder String

The parent resource that contains the logging 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: "folders/my-folder-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/folderBucketConfig:FolderBucketConfig default folders/{{folder}}/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.