Bucket class

Creates a new bucket.

Constructors

Bucket(String name, {BucketArgs? args, CustomResourceOptions? options})

Creates a new Bucket. name The Pulumi resource name. args Arguments used to configure this Bucket. The set of arguments for Bucket. options Resource options controlling this resource's behavior.

Properties

acl ↔ Output<List<Map<String, dynamic>>>

Access controls on the bucket.

late, final

autoclass ↔ Output<BucketAutoclassResponse>

The bucket's Autoclass configuration.

late, final

billing ↔ Output<BucketBillingResponse>

The bucket's billing configuration.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

cors ↔ Output<List<Map<String, dynamic>>>

The bucket's Cross-Origin Resource Sharing (CORS) configuration.

late, final

customPlacementConfig ↔ Output<BucketCustomPlacementConfigResponse>

The bucket's custom placement configuration for Custom Dual Regions.

late, final

defaultEventBasedHold ↔ Output<bool>

The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.

late, final

defaultObjectAcl ↔ Output<List<Map<String, dynamic>>>

Default access controls to apply to new objects when no ACL is provided.

late, final

enableObjectRetention ↔ Output<bool?>

When set to true, object retention is enabled for this bucket.

late, final

encryption ↔ Output<BucketEncryptionResponse>

Encryption configuration for a bucket.

late, final

etag ↔ Output<String>

HTTP 1.1 Entity tag for the bucket.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

iamConfiguration ↔ Output<BucketIamConfigurationResponse>

The bucket's IAM configuration.

late, final

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

kind ↔ Output<String>

The kind of item this is. For buckets, this is always storage#bucket.

late, final

labels ↔ Output<Map<String, String>>

User-provided labels, in key/value pairs.

late, final

lifecycle ↔ Output<BucketLifecycleResponse>

The bucket's lifecycle configuration. See lifecycle management for more information.

late, final

location ↔ Output<String>

The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.

late, final

locationType ↔ Output<String>

The type of the bucket location.

late, final

logging ↔ Output<BucketLoggingResponse>

The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.

late, final

metageneration ↔ Output<String>

The metadata generation of this bucket.

late, final

name ↔ Output<String>

The name of the bucket.

late, final

objectRetention ↔ Output<BucketObjectRetentionResponse>

The bucket's object retention config.

late, final

owner ↔ Output<BucketOwnerResponse>

The owner of the bucket. This is always the project team's owner group.

late, final

predefinedAcl ↔ Output<String?>

Apply a predefined set of access controls to this bucket.

late, final

predefinedDefaultObjectAcl ↔ Output<String?>

Apply a predefined set of default object access controls to this bucket.

late, final

project ↔ Output<String>

A valid API project identifier.

late, final

projection ↔ Output<String?>

Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.

late, final

projectNumber ↔ Output<String>

The project number of the project the bucket belongs to.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

retentionPolicy ↔ Output<BucketRetentionPolicyResponse>

The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.

late, final

rpo ↔ Output<String>

The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

satisfiesPZS ↔ Output<bool>

Reserved for future use.

late, final

selfLink ↔ Output<String>

The URI of this bucket.

late, final

softDeletePolicy ↔ Output<BucketSoftDeletePolicyResponse>

The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted.

late, final

storageClass ↔ Output<String>

The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.

late, final

timeCreated ↔ Output<String>

The creation time of the bucket in RFC 3339 format.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updated ↔ Output<String>

The modification time of the bucket in RFC 3339 format.

late, final

urn ↔ Output<String>

late, final, inherited

userProject ↔ Output<String?>

The project to be billed for this request.

late, final

versioning ↔ Output<BucketVersioningResponse>

The bucket's versioning configuration.

late, final

website ↔ Output<BucketWebsiteResponse>

The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited