Skip to main content
Creates a new bucket.
External DocumentationTo learn more, visit the GCP documentation.

Basic Parameters

ParameterDescription
NameThe name of the bucket.
ProjectA valid API project identifier.
Retention PeriodThe duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.

Advanced Parameters

ParameterDescription
AclAccess controls on the bucket.
Billing Requester PaysWhen set to true, Requester Pays is enabled for this bucket.
Bucket Policy Only EnabledIf set, access is controlled only by bucket-level or above IAM policies.
Bucket Policy Only Locked TimeThe deadline for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable.
CORSThe bucket’s Cross-Origin Resource Sharing (CORS) configuration.
Custom Placement Config Data LocationsThe list of regional locations in which data is placed.
Default Event Based HoldThe 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.
Default Object AclDefault access controls to apply to new objects when no ACL is provided.
Encryption Default Kms Key NameA Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.
IDThe ID of the bucket. For buckets, the id and name properties are the same.
Iam Configuration Public Access PreventionThe bucket’s Public Access Prevention configuration. Currently, ‘unspecified’ and ‘enforced’ are supported.
KindThe kind of item this is. For buckets, this is always storage#bucket.
LabelsUser-provided labels, in key/value pairs.
Lifecycle RuleA lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
LocationThe 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.
Location TypeThe type of the bucket location.
Logging Log BucketThe destination bucket where the current bucket’s logs should be placed.
Logging Log Object PrefixA prefix for log object names.
MetagenerationThe metadata generation of this bucket.
Owner EntityThe entity, in the form project-owner-projectId.
Owner Entity IDThe ID for the entity.
Predefined AclApply a predefined set of access controls to this bucket.
Predefined Default Object AclApply a predefined set of default object access controls to this bucket.
Project NumberThe project number of the project the bucket belongs to.
ProjectionSet of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.
Provisional User ProjectThe project to be billed for this request if the target bucket is requester-pays bucket.
Retention Policy Effective TimeServer-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.
Retention Policy Is LockedOnce locked, an object retention policy cannot be modified.
RpoThe Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
Satisfies PZSReserved for future use.
Storage ClassThe 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.
Uniform Bucket Level Access EnabledIf set, access is controlled only by bucket-level or above IAM policies.
Uniform Bucket Level Access Locked TimeThe deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled may be changed from true to false until the locked time, after which the field is immutable.
User ProjectThe project to be billed for this request.
Versioning EnabledWhile set to true, versioning is fully enabled for this bucket.
Website Main Page SuffixIf 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.
Website Not Found PageIf 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.

Example Output

Workflow Library Example

Create Storage Bucket with Gcp and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop