import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages a billing account level logging bucket config. For more information see * [the official logging documentation](https://cloud.google.com/logging/docs/) and * [Storing Logs](https://cloud.google.com/logging/docs/storage). * * > **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 * * ```typescript * 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", * }); * ``` * * Create logging bucket with index configs * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example_billing_account_bucket_index_configs = new gcp.logging.BillingAccountBucketConfig("example-billing-account-bucket-index-configs", { * folder: _default.billingAccount, * location: "global", * retentionDays: 30, * bucketId: "_Default", * indexConfigs: [{ * fieldPath: "jsonPayload.request.status", * type: "INDEX_TYPE_STRING", * }], * }); * ``` * * ## 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: * * ```sh * $ pulumi import gcp:logging/billingAccountBucketConfig:BillingAccountBucketConfig default billingAccounts/{{billingAccount}}/locations/{{location}}/buckets/{{bucket_id}} * ``` */ export declare class BillingAccountBucketConfig extends pulumi.CustomResource { /** * Get an existing BillingAccountBucketConfig resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: BillingAccountBucketConfigState, opts?: pulumi.CustomResourceOptions): BillingAccountBucketConfig; /** * Returns true if the given object is an instance of BillingAccountBucketConfig. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is BillingAccountBucketConfig; /** * The parent resource that contains the logging bucket. */ readonly billingAccount: pulumi.Output; /** * The name of the logging bucket. Logging automatically creates two log buckets: `_Required` and `_Default`. */ readonly bucketId: pulumi.Output; /** * 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. */ readonly cmekSettings: pulumi.Output; /** * Describes this bucket. */ readonly description: pulumi.Output; /** * A list of indexed fields and related configuration data. Structure is documented below. */ readonly indexConfigs: pulumi.Output; /** * The bucket's lifecycle such as active or deleted. See [LifecycleState](https://cloud.google.com/logging/docs/reference/v2/rest/v2/billingAccounts.buckets#LogBucket.LifecycleState). */ readonly lifecycleState: pulumi.Output; /** * The location of the bucket. */ readonly location: pulumi.Output; /** * The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" */ readonly name: pulumi.Output; /** * 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. */ readonly retentionDays: pulumi.Output; /** * Create a BillingAccountBucketConfig resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: BillingAccountBucketConfigArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering BillingAccountBucketConfig resources. */ export interface BillingAccountBucketConfigState { /** * The parent resource that contains the logging bucket. */ billingAccount?: pulumi.Input; /** * The name of the logging bucket. Logging automatically creates two log buckets: `_Required` and `_Default`. */ bucketId?: pulumi.Input; /** * 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. */ cmekSettings?: pulumi.Input; /** * Describes this bucket. */ description?: pulumi.Input; /** * A list of indexed fields and related configuration data. Structure is documented below. */ indexConfigs?: pulumi.Input[]>; /** * The bucket's lifecycle such as active or deleted. See [LifecycleState](https://cloud.google.com/logging/docs/reference/v2/rest/v2/billingAccounts.buckets#LogBucket.LifecycleState). */ lifecycleState?: pulumi.Input; /** * The location of the bucket. */ location?: pulumi.Input; /** * The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" */ name?: pulumi.Input; /** * 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. */ retentionDays?: pulumi.Input; } /** * The set of arguments for constructing a BillingAccountBucketConfig resource. */ export interface BillingAccountBucketConfigArgs { /** * The parent resource that contains the logging bucket. */ billingAccount: pulumi.Input; /** * The name of the logging bucket. Logging automatically creates two log buckets: `_Required` and `_Default`. */ bucketId: pulumi.Input; /** * 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. */ cmekSettings?: pulumi.Input; /** * Describes this bucket. */ description?: pulumi.Input; /** * A list of indexed fields and related configuration data. Structure is documented below. */ indexConfigs?: pulumi.Input[]>; /** * The location of the bucket. */ location: pulumi.Input; /** * 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. */ retentionDays?: pulumi.Input; }