pulumi-gcp-kotlin/com.pulumi.gcp.logging.kotlin/ProjectBucketConfig

ProjectBucketConfig

class ProjectBucketConfig : KotlinCustomResource

Manages a project-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

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.Project;
import com.pulumi.gcp.organizations.ProjectArgs;
import com.pulumi.gcp.logging.ProjectBucketConfig;
import com.pulumi.gcp.logging.ProjectBucketConfigArgs;
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 Project("default", ProjectArgs.builder()
            .projectId("your-project-id")
            .orgId("123456789")
            .build());
        var basic = new ProjectBucketConfig("basic", ProjectBucketConfigArgs.builder()
            .project(default_.projectId())
            .location("global")
            .retentionDays(30)
            .bucketId("_Default")
            .build());
    }
}

Import

This resource can be imported using the following format:

$ pulumi import gcp:logging/projectBucketConfig:ProjectBucketConfig default projects/{{project}}/locations/{{location}}/buckets/{{bucket_id}}

Properties

bucketId

val bucketId: Output<String>

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

cmekSettings

val cmekSettings: Output<ProjectBucketConfigCmekSettings>?

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. Structure is documented below.

description

val description: Output<String>

Describes this bucket.

enableAnalytics

val enableAnalytics: Output<Boolean>?

Whether or not Log Analytics is enabled. Logs for buckets with Log Analytics enabled can be queried in the Log Analytics page using SQL queries. Cannot be disabled once enabled.

val id: Output<String>

lifecycleState

val lifecycleState: Output<String>

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

location

val location: Output<String>

The location of the bucket.

locked

val locked: Output<Boolean>?

Whether the bucket is locked. The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.

name

val name: Output<String>

The resource name of the CMEK settings.

project

val project: Output<String>

The parent resource that contains the logging bucket.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

retentionDays

val retentionDays: Output<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.

urn

val urn: Output<String>