Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. logging
  5. BillingAccountBucketConfig
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.logging.BillingAccountBucketConfig

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-gcp

    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

    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",
});

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

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

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

return await Deployment.RunAsync(() => 
{
    var @default = Gcp.Organizations.GetBillingAccount.Invoke(new()
    {
        BillingAccount = "00AA00-000AAA-00AA0A",
    });

    var basic = new Gcp.Logging.BillingAccountBucketConfig("basic", new()
    {
        BillingAccount = @default.Apply(@default => @default.Apply(getBillingAccountResult => getBillingAccountResult.BillingAccount)),
        Location = "global",
        RetentionDays = 30,
        BucketId = "_Default",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetBillingAccountArgs;
import com.pulumi.gcp.logging.BillingAccountBucketConfig;
import com.pulumi.gcp.logging.BillingAccountBucketConfigArgs;
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) {
        final var default = OrganizationsFunctions.getBillingAccount(GetBillingAccountArgs.builder()
            .billingAccount("00AA00-000AAA-00AA0A")
            .build());

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

    }
}

    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 logging bucket with index configs

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  example-billing-account-bucket-index-configs:
    type: gcp:logging:BillingAccountBucketConfig
    properties:
      folder: ${default.billingAccount}
      location: global
      retentionDays: 30
      bucketId: _Default
      indexConfigs:
        - fieldPath: jsonPayload.request.status
          type: INDEX_TYPE_STRING

    Create BillingAccountBucketConfig Resource

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

    Constructor syntax

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

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

    Parameters

    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.

    Constructor example

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

    var billingAccountBucketConfigResource = new Gcp.Logging.BillingAccountBucketConfig("billingAccountBucketConfigResource", new()
{
    BillingAccount = "string",
    BucketId = "string",
    Location = "string",
    CmekSettings = new Gcp.Logging.Inputs.BillingAccountBucketConfigCmekSettingsArgs
    {
        KmsKeyName = "string",
        KmsKeyVersionName = "string",
        Name = "string",
        ServiceAccountId = "string",
    },
    Description = "string",
    IndexConfigs = new[]
    {
        new Gcp.Logging.Inputs.BillingAccountBucketConfigIndexConfigArgs
        {
            FieldPath = "string",
            Type = "string",
        },
    },
    RetentionDays = 0,
});

    example, err := logging.NewBillingAccountBucketConfig(ctx, "billingAccountBucketConfigResource", &logging.BillingAccountBucketConfigArgs{
	BillingAccount: pulumi.String("string"),
	BucketId:       pulumi.String("string"),
	Location:       pulumi.String("string"),
	CmekSettings: &logging.BillingAccountBucketConfigCmekSettingsArgs{
		KmsKeyName:        pulumi.String("string"),
		KmsKeyVersionName: pulumi.String("string"),
		Name:              pulumi.String("string"),
		ServiceAccountId:  pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	IndexConfigs: logging.BillingAccountBucketConfigIndexConfigArray{
		&logging.BillingAccountBucketConfigIndexConfigArgs{
			FieldPath: pulumi.String("string"),
			Type:      pulumi.String("string"),
		},
	},
	RetentionDays: pulumi.Int(0),
})

    var billingAccountBucketConfigResource = new BillingAccountBucketConfig("billingAccountBucketConfigResource", BillingAccountBucketConfigArgs.builder()
    .billingAccount("string")
    .bucketId("string")
    .location("string")
    .cmekSettings(BillingAccountBucketConfigCmekSettingsArgs.builder()
        .kmsKeyName("string")
        .kmsKeyVersionName("string")
        .name("string")
        .serviceAccountId("string")
        .build())
    .description("string")
    .indexConfigs(BillingAccountBucketConfigIndexConfigArgs.builder()
        .fieldPath("string")
        .type("string")
        .build())
    .retentionDays(0)
    .build());

    billing_account_bucket_config_resource = gcp.logging.BillingAccountBucketConfig("billingAccountBucketConfigResource",
    billing_account="string",
    bucket_id="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 billingAccountBucketConfigResource = new gcp.logging.BillingAccountBucketConfig("billingAccountBucketConfigResource", {
    billingAccount: "string",
    bucketId: "string",
    location: "string",
    cmekSettings: {
        kmsKeyName: "string",
        kmsKeyVersionName: "string",
        name: "string",
        serviceAccountId: "string",
    },
    description: "string",
    indexConfigs: [{
        fieldPath: "string",
        type: "string",
    }],
    retentionDays: 0,
});

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

    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

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

    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.
    CmekSettings BillingAccountBucketConfigCmekSettings
    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<BillingAccountBucketConfigIndexConfig>
    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.
    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.
    CmekSettings BillingAccountBucketConfigCmekSettingsArgs
    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 []BillingAccountBucketConfigIndexConfigArgs
    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.
    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.
    cmekSettings BillingAccountBucketConfigCmekSettings
    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<BillingAccountBucketConfigIndexConfig>
    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.
    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.
    cmekSettings BillingAccountBucketConfigCmekSettings
    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 BillingAccountBucketConfigIndexConfig[]
    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.
    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.
    cmek_settings BillingAccountBucketConfigCmekSettingsArgs
    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[BillingAccountBucketConfigIndexConfigArgs]
    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.
    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.
    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 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 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,
        cmek_settings: Optional[BillingAccountBucketConfigCmekSettingsArgs] = None,
        description: Optional[str] = None,
        index_configs: Optional[Sequence[BillingAccountBucketConfigIndexConfigArgs]] = 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.
    CmekSettings BillingAccountBucketConfigCmekSettings
    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<BillingAccountBucketConfigIndexConfig>
    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: "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.
    CmekSettings BillingAccountBucketConfigCmekSettingsArgs
    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 []BillingAccountBucketConfigIndexConfigArgs
    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: "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.
    cmekSettings BillingAccountBucketConfigCmekSettings
    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<BillingAccountBucketConfigIndexConfig>
    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: "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.
    cmekSettings BillingAccountBucketConfigCmekSettings
    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 BillingAccountBucketConfigIndexConfig[]
    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: "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.
    cmek_settings BillingAccountBucketConfigCmekSettingsArgs
    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[BillingAccountBucketConfigIndexConfigArgs]
    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: "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.
    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.
    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.

    Supporting Types

    BillingAccountBucketConfigCmekSettings, BillingAccountBucketConfigCmekSettingsArgs

    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: "projects/my-project-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: "projects/my-project-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: "projects/my-project-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: "projects/my-project-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: "projects/my-project-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: "projects/my-project-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.

    BillingAccountBucketConfigIndexConfig, BillingAccountBucketConfigIndexConfigArgs

    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:

    • billingAccounts/{{billingAccount}}/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/billingAccountBucketConfig:BillingAccountBucketConfig default billingAccounts/{{billingAccount}}/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 Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-gcp