Package com.hashicorp.cdktf.providers.google.storage_bucket

Interface StorageBucketRetentionPolicy

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StorageBucketRetentionPolicy.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.825Z")
@Stability(Stable)
public interface StorageBucketRetentionPolicy
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	StorageBucketRetentionPolicy.Builder	A builder for StorageBucketRetentionPolicy
static class	StorageBucketRetentionPolicy.Jsii$Proxy	An implementation for StorageBucketRetentionPolicy

Method Summary

Modifier and Type	Method	Description
static StorageBucketRetentionPolicy.Builder	builder()
default Object	getIsLocked()	If set to true, the bucket will be locked and permanently restrict edits to the bucket's retention policy.
Number	getRetentionPeriod()	The period of time, in seconds, that objects in the bucket must be retained and cannot be deleted, overwritten, or archived.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRetentionPeriod

@Stability(Stable)
@NotNull
Number getRetentionPeriod()

The period of time, in seconds, that objects in the bucket must be retained and cannot be deleted, overwritten, or archived.

The value must be less than 3,155,760,000 seconds. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#retention_period StorageBucket#retention_period}

getIsLocked

@Stability(Stable)
@Nullable
default Object getIsLocked()

If set to true, the bucket will be locked and permanently restrict edits to the bucket's retention policy.

Caution: Locking a bucket is an irreversible action. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#is_locked StorageBucket#is_locked}

builder

@Stability(Stable)
static StorageBucketRetentionPolicy.Builder builder()

Returns:

a StorageBucketRetentionPolicy.Builder of StorageBucketRetentionPolicy