Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. logging
  5. FolderBucketConfig
Google Cloud v8.36.0 published on Friday, Jun 27, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.logging.FolderBucketConfig

Explore with Pulumi AI

gcp logo
Google Cloud v8.36.0 published on Friday, Jun 27, 2025 by Pulumi
pulumi/pulumi-gcp

    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

    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",
    indexConfigs: [{
        fieldPath: "jsonPayload.request.status",
        type: "INDEX_TYPE_STRING",
    }],
});

    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",
    index_configs=[{
        "field_path": "jsonPayload.request.status",
        "type": "INDEX_TYPE_STRING",
    }])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, 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"),
			IndexConfigs: logging.FolderBucketConfigIndexConfigArray{
				&logging.FolderBucketConfigIndexConfigArgs{
					FieldPath: pulumi.String("jsonPayload.request.status"),
					Type:      pulumi.String("INDEX_TYPE_STRING"),
				},
			},
		})
		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 @default = new Gcp.Organizations.Folder("default", new()
    {
        DisplayName = "some-folder-name",
        Parent = "organizations/123456789",
    });

    var basic = new Gcp.Logging.FolderBucketConfig("basic", new()
    {
        Folder = @default.Name,
        Location = "global",
        RetentionDays = 30,
        BucketId = "_Default",
        IndexConfigs = new[]
        {
            new Gcp.Logging.Inputs.FolderBucketConfigIndexConfigArgs
            {
                FieldPath = "jsonPayload.request.status",
                Type = "INDEX_TYPE_STRING",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.Folder;
import com.pulumi.gcp.organizations.FolderArgs;
import com.pulumi.gcp.logging.FolderBucketConfig;
import com.pulumi.gcp.logging.FolderBucketConfigArgs;
import com.pulumi.gcp.logging.inputs.FolderBucketConfigIndexConfigArgs;
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 default_ = new Folder("default", FolderArgs.builder()
            .displayName("some-folder-name")
            .parent("organizations/123456789")
            .build());

        var basic = new FolderBucketConfig("basic", FolderBucketConfigArgs.builder()
            .folder(default_.name())
            .location("global")
            .retentionDays(30)
            .bucketId("_Default")
            .indexConfigs(FolderBucketConfigIndexConfigArgs.builder()
                .fieldPath("jsonPayload.request.status")
                .type("INDEX_TYPE_STRING")
                .build())
            .build());

    }
}

    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
      indexConfigs:
        - fieldPath: jsonPayload.request.status
          type: INDEX_TYPE_STRING

    Create FolderBucketConfig Resource

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

    Constructor syntax

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

@overload
def FolderBucketConfig(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       bucket_id: Optional[str] = None,
                       folder: Optional[str] = None,
                       location: Optional[str] = None,
                       cmek_settings: Optional[FolderBucketConfigCmekSettingsArgs] = None,
                       description: Optional[str] = None,
                       index_configs: Optional[Sequence[FolderBucketConfigIndexConfigArgs]] = None,
                       retention_days: Optional[int] = 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.

    Parameters

    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.

    Constructor example

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

    var folderBucketConfigResource = new Gcp.Logging.FolderBucketConfig("folderBucketConfigResource", new()
{
    BucketId = "string",
    Folder = "string",
    Location = "string",
    CmekSettings = new Gcp.Logging.Inputs.FolderBucketConfigCmekSettingsArgs
    {
        KmsKeyName = "string",
        KmsKeyVersionName = "string",
        Name = "string",
        ServiceAccountId = "string",
    },
    Description = "string",
    IndexConfigs = new[]
    {
        new Gcp.Logging.Inputs.FolderBucketConfigIndexConfigArgs
        {
            FieldPath = "string",
            Type = "string",
        },
    },
    RetentionDays = 0,
});

    example, err := logging.NewFolderBucketConfig(ctx, "folderBucketConfigResource", &logging.FolderBucketConfigArgs{
	BucketId: pulumi.String("string"),
	Folder:   pulumi.String("string"),
	Location: pulumi.String("string"),
	CmekSettings: &logging.FolderBucketConfigCmekSettingsArgs{
		KmsKeyName:        pulumi.String("string"),
		KmsKeyVersionName: pulumi.String("string"),
		Name:              pulumi.String("string"),
		ServiceAccountId:  pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	IndexConfigs: logging.FolderBucketConfigIndexConfigArray{
		&logging.FolderBucketConfigIndexConfigArgs{
			FieldPath: pulumi.String("string"),
			Type:      pulumi.String("string"),
		},
	},
	RetentionDays: pulumi.Int(0),
})

    var folderBucketConfigResource = new FolderBucketConfig("folderBucketConfigResource", FolderBucketConfigArgs.builder()
    .bucketId("string")
    .folder("string")
    .location("string")
    .cmekSettings(FolderBucketConfigCmekSettingsArgs.builder()
        .kmsKeyName("string")
        .kmsKeyVersionName("string")
        .name("string")
        .serviceAccountId("string")
        .build())
    .description("string")
    .indexConfigs(FolderBucketConfigIndexConfigArgs.builder()
        .fieldPath("string")
        .type("string")
        .build())
    .retentionDays(0)
    .build());

    folder_bucket_config_resource = gcp.logging.FolderBucketConfig("folderBucketConfigResource",
    bucket_id="string",
    folder="string",
    location="string",
    cmek_settings={
        "kms_key_name": "string",
        "kms_key_version_name": "string",
        "name": "string",
        "service_account_id": "string",
    },
    description="string",
    index_configs=[{
        "field_path": "string",
        "type": "string",
    }],
    retention_days=0)

    const folderBucketConfigResource = new gcp.logging.FolderBucketConfig("folderBucketConfigResource", {
    bucketId: "string",
    folder: "string",
    location: "string",
    cmekSettings: {
        kmsKeyName: "string",
        kmsKeyVersionName: "string",
        name: "string",
        serviceAccountId: "string",
    },
    description: "string",
    indexConfigs: [{
        fieldPath: "string",
        type: "string",
    }],
    retentionDays: 0,
});

    type: gcp:logging:FolderBucketConfig
properties:
    bucketId: string
    cmekSettings:
        kmsKeyName: string
        kmsKeyVersionName: string
        name: string
        serviceAccountId: string
    description: string
    folder: string
    indexConfigs:
        - fieldPath: string
          type: string
    location: string
    retentionDays: 0

    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

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

    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.
    CmekSettings FolderBucketConfigCmekSettings
    The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
    Description string
    Describes this bucket.
    IndexConfigs List<FolderBucketConfigIndexConfig>
    A list of indexed fields and related configuration data. Structure is documented below.
    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.
    CmekSettings FolderBucketConfigCmekSettingsArgs
    The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
    Description string
    Describes this bucket.
    IndexConfigs []FolderBucketConfigIndexConfigArgs
    A list of indexed fields and related configuration data. Structure is documented below.
    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.
    cmekSettings FolderBucketConfigCmekSettings
    The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
    description String
    Describes this bucket.
    indexConfigs List<FolderBucketConfigIndexConfig>
    A list of indexed fields and related configuration data. Structure is documented below.
    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.
    cmekSettings FolderBucketConfigCmekSettings
    The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
    description string
    Describes this bucket.
    indexConfigs FolderBucketConfigIndexConfig[]
    A list of indexed fields and related configuration data. Structure is documented below.
    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.
    cmek_settings FolderBucketConfigCmekSettingsArgs
    The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
    description str
    Describes this bucket.
    index_configs Sequence[FolderBucketConfigIndexConfigArgs]
    A list of indexed fields and related configuration data. Structure is documented below.
    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.
    cmekSettings Property Map
    The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
    description String
    Describes this bucket.
    indexConfigs List<Property Map>
    A list of indexed fields and related configuration data. Structure is documented below.
    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 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,
        cmek_settings: Optional[FolderBucketConfigCmekSettingsArgs] = None,
        description: Optional[str] = None,
        folder: Optional[str] = None,
        index_configs: Optional[Sequence[FolderBucketConfigIndexConfigArgs]] = 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)
    resources:  _:    type: gcp:logging:FolderBucketConfig    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:
    BucketId string
    The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.
    CmekSettings FolderBucketConfigCmekSettings
    The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
    Description string
    Describes this bucket.
    Folder string
    The parent resource that contains the logging bucket.
    IndexConfigs List<FolderBucketConfigIndexConfig>
    A list of indexed fields and related configuration data. Structure is documented below.
    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.
    CmekSettings FolderBucketConfigCmekSettingsArgs
    The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
    Description string
    Describes this bucket.
    Folder string
    The parent resource that contains the logging bucket.
    IndexConfigs []FolderBucketConfigIndexConfigArgs
    A list of indexed fields and related configuration data. Structure is documented below.
    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.
    cmekSettings FolderBucketConfigCmekSettings
    The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
    description String
    Describes this bucket.
    folder String
    The parent resource that contains the logging bucket.
    indexConfigs List<FolderBucketConfigIndexConfig>
    A list of indexed fields and related configuration data. Structure is documented below.
    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.
    cmekSettings FolderBucketConfigCmekSettings
    The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
    description string
    Describes this bucket.
    folder string
    The parent resource that contains the logging bucket.
    indexConfigs FolderBucketConfigIndexConfig[]
    A list of indexed fields and related configuration data. Structure is documented below.
    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.
    cmek_settings FolderBucketConfigCmekSettingsArgs
    The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
    description str
    Describes this bucket.
    folder str
    The parent resource that contains the logging bucket.
    index_configs Sequence[FolderBucketConfigIndexConfigArgs]
    A list of indexed fields and related configuration data. Structure is documented below.
    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.
    cmekSettings Property Map
    The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
    description String
    Describes this bucket.
    folder String
    The parent resource that contains the logging bucket.
    indexConfigs List<Property Map>
    A list of indexed fields and related configuration data. Structure is documented below.
    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.

    Supporting Types

    FolderBucketConfigCmekSettings, FolderBucketConfigCmekSettingsArgs

    KmsKeyName string
    The resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" To enable CMEK for the bucket, set this field to a valid kmsKeyName for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the bucket can be updated by changing the kmsKeyName to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. See Enabling CMEK for Logging Buckets for more information.
    KmsKeyVersionName string
    The CryptoKeyVersion resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example: "projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1" This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.
    Name string
    The resource name of the bucket. For example: "folders/my-folder-id/locations/my-location/buckets/my-bucket-id"
    ServiceAccountId string
    The service account associated with a project for which CMEK will apply. Before enabling CMEK for a logging bucket, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account associated with the project for which CMEK will apply. Use v2.getCmekSettings to obtain the service account ID. See Enabling CMEK for Logging Buckets for more information.
    KmsKeyName string
    The resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" To enable CMEK for the bucket, set this field to a valid kmsKeyName for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the bucket can be updated by changing the kmsKeyName to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. See Enabling CMEK for Logging Buckets for more information.
    KmsKeyVersionName string
    The CryptoKeyVersion resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example: "projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1" This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.
    Name string
    The resource name of the bucket. For example: "folders/my-folder-id/locations/my-location/buckets/my-bucket-id"
    ServiceAccountId string
    The service account associated with a project for which CMEK will apply. Before enabling CMEK for a logging bucket, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account associated with the project for which CMEK will apply. Use v2.getCmekSettings to obtain the service account ID. See Enabling CMEK for Logging Buckets for more information.
    kmsKeyName String
    The resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" To enable CMEK for the bucket, set this field to a valid kmsKeyName for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the bucket can be updated by changing the kmsKeyName to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. See Enabling CMEK for Logging Buckets for more information.
    kmsKeyVersionName String
    The CryptoKeyVersion resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example: "projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1" This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.
    name String
    The resource name of the bucket. For example: "folders/my-folder-id/locations/my-location/buckets/my-bucket-id"
    serviceAccountId String
    The service account associated with a project for which CMEK will apply. Before enabling CMEK for a logging bucket, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account associated with the project for which CMEK will apply. Use v2.getCmekSettings to obtain the service account ID. See Enabling CMEK for Logging Buckets for more information.
    kmsKeyName string
    The resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" To enable CMEK for the bucket, set this field to a valid kmsKeyName for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the bucket can be updated by changing the kmsKeyName to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. See Enabling CMEK for Logging Buckets for more information.
    kmsKeyVersionName string
    The CryptoKeyVersion resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example: "projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1" This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.
    name string
    The resource name of the bucket. For example: "folders/my-folder-id/locations/my-location/buckets/my-bucket-id"
    serviceAccountId string
    The service account associated with a project for which CMEK will apply. Before enabling CMEK for a logging bucket, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account associated with the project for which CMEK will apply. Use v2.getCmekSettings to obtain the service account ID. See Enabling CMEK for Logging Buckets for more information.
    kms_key_name str
    The resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" To enable CMEK for the bucket, set this field to a valid kmsKeyName for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the bucket can be updated by changing the kmsKeyName to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. See Enabling CMEK for Logging Buckets for more information.
    kms_key_version_name str
    The CryptoKeyVersion resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example: "projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1" This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.
    name str
    The resource name of the bucket. For example: "folders/my-folder-id/locations/my-location/buckets/my-bucket-id"
    service_account_id str
    The service account associated with a project for which CMEK will apply. Before enabling CMEK for a logging bucket, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account associated with the project for which CMEK will apply. Use v2.getCmekSettings to obtain the service account ID. See Enabling CMEK for Logging Buckets for more information.
    kmsKeyName String
    The resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" To enable CMEK for the bucket, set this field to a valid kmsKeyName for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the bucket can be updated by changing the kmsKeyName to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. See Enabling CMEK for Logging Buckets for more information.
    kmsKeyVersionName String
    The CryptoKeyVersion resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example: "projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1" This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.
    name String
    The resource name of the bucket. For example: "folders/my-folder-id/locations/my-location/buckets/my-bucket-id"
    serviceAccountId String
    The service account associated with a project for which CMEK will apply. Before enabling CMEK for a logging bucket, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account associated with the project for which CMEK will apply. Use v2.getCmekSettings to obtain the service account ID. See Enabling CMEK for Logging Buckets for more information.

    FolderBucketConfigIndexConfig, FolderBucketConfigIndexConfigArgs

    FieldPath string
    The LogEntry field path to index. Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation for details.
    Type string
    The type of data in this index. Allowed types include INDEX_TYPE_UNSPECIFIED, INDEX_TYPE_STRING and INDEX_TYPE_INTEGER.
    FieldPath string
    The LogEntry field path to index. Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation for details.
    Type string
    The type of data in this index. Allowed types include INDEX_TYPE_UNSPECIFIED, INDEX_TYPE_STRING and INDEX_TYPE_INTEGER.
    fieldPath String
    The LogEntry field path to index. Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation for details.
    type String
    The type of data in this index. Allowed types include INDEX_TYPE_UNSPECIFIED, INDEX_TYPE_STRING and INDEX_TYPE_INTEGER.
    fieldPath string
    The LogEntry field path to index. Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation for details.
    type string
    The type of data in this index. Allowed types include INDEX_TYPE_UNSPECIFIED, INDEX_TYPE_STRING and INDEX_TYPE_INTEGER.
    field_path str
    The LogEntry field path to index. Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation for details.
    type str
    The type of data in this index. Allowed types include INDEX_TYPE_UNSPECIFIED, INDEX_TYPE_STRING and INDEX_TYPE_INTEGER.
    fieldPath String
    The LogEntry field path to index. Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation for details.
    type String
    The type of data in this index. Allowed types include INDEX_TYPE_UNSPECIFIED, INDEX_TYPE_STRING and INDEX_TYPE_INTEGER.

    Import

    This resource can be imported using the following format:

    • folders/{{folder}}/locations/{{location}}/buckets/{{bucket_id}}

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

    $ pulumi import gcp:logging/folderBucketConfig:FolderBucketConfig default folders/{{folder}}/locations/{{location}}/buckets/{{bucket_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.36.0 published on Friday, Jun 27, 2025 by Pulumi
    pulumi/pulumi-gcp