Required Properties
|
name
|
string
|
The name of the bucket. See the
bucket naming guidelines
for more information.
|
|
Optional Properties
|
acl[]
|
list
|
Access controls on the bucket, containing one or more
bucketAccessControls
Resources
. If
iamConfiguration.uniformBucketLevelAccess.enabled
is set
to
true
, this field is omitted in responses, and requests that specify this
field fail with a
400 Bad Request
response.
|
writable
|
autoclass
|
object
|
The bucket's
Autoclass configuration
, which,
when enabled, controls the storage class of objects based on how and when the objects
are accessed.
|
writable
|
autoclass.enabled
|
boolean
|
Whether or not Autoclass is enabled. By default, this boolean is not set, and
Autoclass is disabled.
|
writable
|
autoclass.terminalStorageClass
|
string
|
The coldest storage class that an object in an Autoclass-enabled bucket transitions to
if it is not accessed. Valid values are
NEARLINE
and
ARCHIVE
.
The default value is
NEARLINE
.
|
writable
|
billing
|
object
|
The bucket's billing configuration.
|
writable
|
billing.requesterPays
|
boolean
|
When set to true,
Requester Pays
is enabled
for this bucket.
|
writable
|
cors[]
|
list
|
The bucket's
Cross-Origin
Resource Sharing
(CORS) configuration.
|
writable
|
cors[].maxAgeSeconds
|
integer
|
The value, in seconds, to return in the
Access-Control-Max-Age
header
used in preflight responses.
|
writable
|
cors[].method[]
|
list
|
The list of HTTP methods on which to include CORS response headers, (
"GET"
,
"OPTIONS"
,
"POST"
, etc) Note: "*" is permitted in the list of
methods, and means "any method".
|
writable
|
cors[].origin[]
|
list
|
The list of
Origins
eligible to receive CORS response headers. Note: "*" is permitted in the list of origins,
and means "any Origin".
|
writable
|
customPlacementConfig
|
object
|
The bucket's custom location configuration, which specifies the individual regions that
comprise a dual-region bucket. This parameter is only applicable if the bucket is located
in a dual-region and only if the dual-region is not predefined.
|
writable
|
dataLocations
|
list
|
The list of individual regions that comprise a dual-region bucket. See
Cloud Storage bucket locations
for a list of acceptable regions.
|
writable
|
defaultEventBasedHold
|
boolean
|
Whether or not to automatically apply
an
eventBasedHold
to new objects added to the bucket.
|
writable
|
defaultObjectAcl[]
|
list
|
Default access controls to apply to new objects when no ACL is provided. This list
defines an
entity
and
role
for one or more
defaultObjectAccessControls Resources
.
If
iamConfiguration.uniformBucketLevelAccess.enabled
is set to
true
, this field is omitted
in responses, and requests that specify this field fail with a
400 Bad Request
response.
|
writable
|
encryption
|
object
|
Encryption configuration for a bucket.
|
writable
|
encryption.defaultKmsKeyName
|
string
|
A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no
encryption method is specified.
|
|
iamConfiguration
|
object
|
The bucket's IAM configuration.
|
writable
|
iamConfiguration.publicAccessPrevention
|
string
|
The bucket's
public access
prevention
status. Acceptable values are
"inherited"
or
"enforced"
. If
"inherited"
, the bucket uses public access
prevention only if the bucket is subject to the
public access
prevention organization policy constraint
. Defaults to
"inherited"
.
|
writable
|
iamConfiguration.uniformBucketLevelAccess
|
object
|
The bucket's
uniform bucket-level access
configuration.
Note:
iamConfiguration
also includes the
bucketPolicyOnly
field,
which uses a legacy name but has the same functionality as the
uniformBucketLevelAccess
field.
We recommend only using
uniformBucketLevelAccess
, as specifying
both fields may result in unreliable behavior.
|
writable
|
iamConfiguration.uniformBucketLevelAccess.enabled
|
boolean
|
Whether or not the bucket uses uniform bucket-level access. If set, access checks only use
bucket-level IAM policies or above.
|
writable
|
labels
|
object
|
User-provided
bucket labels
, in
key/value pairs.
|
writable
|
labels.(key)
|
string
|
An individual label entry.
|
writable
|
lifecycle
|
object
|
The bucket's
lifecycle
configuration
. See
lifecycle management
for
more information.
|
writable
|
location
|
string
|
The location of the bucket. Object data for objects in the bucket resides in physical
storage within this location. Defaults to
"US"
.
See
Cloud Storage bucket locations
for the
authoritative list.
|
writable
|
logging
|
object
|
The bucket's logging configuration, which defines the destination bucket and optional
name prefix for the current bucket's
usage logs and storage logs
.
|
writable
|
logging.logBucket
|
string
|
The destination bucket where the current bucket's logs should be placed.
|
writable
|
logging.logObjectPrefix
|
string
|
A prefix for log object names. The default prefix is the bucket name.
|
writable
|
retentionPolicy
|
object
|
The bucket's
retention policy
,
which defines the minimum age an object in the bucket must have to be deleted or
replaced.
|
writable
|
retentionPolicy.retentionPeriod
|
string
|
The period of time, in seconds, that objects in the bucket must be retained and cannot
be deleted, replaced, or made noncurrent. The value must be less than 3,155,760,000
seconds.
|
writable
|
rpo
|
string
|
The recovery point objective for cross-region replication of the bucket. Applicable only
for dual- and multi-region buckets.
"DEFAULT"
uses default replication.
"ASYNC_TURBO"
enables turbo replication, valid for dual-region buckets only.
If
rpo
is not specified when the bucket is created, it defaults to
"DEFAULT"
. For more information, see
redundancy across regions
.
|
writable
|
softDeletePolicy
|
object
|
The bucket's
soft delete policy
, which
defines the period of time that objects in the bucket will be retained after deletion and
cannot be permanently deleted. During this time, objects in the bucket that get deleted can
be restored.
|
writeable
|
softDeletePolicy.effectiveTime
|
datetime
|
The datetime at which the soft delete policy becomes effective, in
RFC 3339
format.
softDeletePolicy.effectiveTime
is newly set whenever
softDeletePolicy.retentionDurationSeconds
is increased.
|
|
softDeletePolicy.retentionDurationSeconds
|
long
|
The period of time during which a soft-deleted object is retained and cannot be
permanently deleted, in seconds. The value must be greater than or equal to
604800
(7 days) and less than
7776000
(90 days).
|
writeable
|
storageClass
|
string
|
The bucket's default storage class, used whenever no
storageClass
is
specified for a newly-created object. If
storageClass
is not specified when
the bucket is created, it defaults to
"STANDARD"
. For available storage
classes, see
Storage classes
.
|
writable
|
versioning
|
object
|
The bucket's versioning configuration. For more information,
see
Object Versioning
.
|
writable
|
versioning.enabled
|
boolean
|
While set to true, versioning is fully enabled for this bucket.
|
writable
|
website
|
object
|
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.
|
writable
|
website.mainPageSuffix
|
string
|
If the requested object path is missing, the service will ensure the path has a
trailing '/', append this suffix, and attempt to retrieve the resulting object. This
allows the creation of
index.html
objects to represent directory pages.
|
writable
|
website.notFoundPage
|
string
|
If the requested object path is missing, and any
mainPageSuffix
object is
missing, if applicable, the service will return the named object from this bucket as the
content for a
404 Not Found
result.
|
writable
|