Create Storage Bucket - BlinkOps Documentation

Creates a new bucket.

External DocumentationTo learn more, visit the GCP documentation.

Basic Parameters

Parameter	Description
Name	The name of the bucket.
Project	A valid API project identifier.
Retention Period	The 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

Parameter	Description
Acl	Access controls on the bucket.
Billing Requester Pays	When set to true, Requester Pays is enabled for this bucket.
Bucket Policy Only Enabled	If set, access is controlled only by bucket-level or above IAM policies.
Bucket Policy Only Locked Time	The 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.
CORS	The bucket’s Cross-Origin Resource Sharing (CORS) configuration.
Custom Placement Config Data Locations	The list of regional locations in which data is placed.
Default Event Based Hold	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.
Default Object Acl	Default access controls to apply to new objects when no ACL is provided.
Encryption Default Kms Key Name	A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.
ID	The ID of the bucket. For buckets, the id and name properties are the same.
Iam Configuration Public Access Prevention	The bucket’s Public Access Prevention configuration. Currently, ‘unspecified’ and ‘enforced’ are supported.
Kind	The kind of item this is. For buckets, this is always storage#bucket.
Labels	User-provided labels, in key/value pairs.
Lifecycle Rule	A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
Location	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.
Location Type	The type of the bucket location.
Logging Log Bucket	The destination bucket where the current bucket’s logs should be placed.
Logging Log Object Prefix	A prefix for log object names.
Metageneration	The metadata generation of this bucket.
Owner Entity	The entity, in the form project-owner-projectId.
Owner Entity ID	The ID for the entity.
Predefined Acl	Apply a predefined set of access controls to this bucket.
Predefined Default Object Acl	Apply a predefined set of default object access controls to this bucket.
Project Number	The project number of the project the bucket belongs to.
Projection	Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.
Provisional User Project	The project to be billed for this request if the target bucket is requester-pays bucket.
Retention Policy Effective Time	Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.
Retention Policy Is Locked	Once locked, an object retention policy cannot be modified.
Rpo	The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
Satisfies PZS	Reserved for future use.
Storage Class	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.
Uniform Bucket Level Access Enabled	If set, access is controlled only by bucket-level or above IAM policies.
Uniform Bucket Level Access Locked Time	The 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 Project	The project to be billed for this request.
Versioning Enabled	While set to true, versioning is fully enabled for this bucket.
Website Main Page Suffix	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.
Website Not Found Page	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.

Example Output

{
	"acl": [
		{
			"bucket": "The name of the bucket.",
			"domain": "The domain associated with the entity, if any.",
			"email": "The email address associated with the entity, if any.",
			"entity": "The entity holding the permission, in one of the following forms:\n- user-userId\n- user-email\n- group-groupId\n- group-email\n- domain-domain\n- project-team-projectId\n- allUsers\n- allAuthenticatedUsers Examples:\n- The user liz@example.com would be user-liz@example.com.\n- The group example@googlegroups.com would be group-example@googlegroups.com.\n- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.",
			"entityId": "The ID for the entity, if any.",
			"etag": "HTTP 1.1 Entity tag for the access-control entry.",
			"id": "The ID of the access-control entry.",
			"kind": "storage#bucketAccessControl",
			"projectTeam": {
				"projectNumber": "The project number.",
				"team": "The team."
			},
			"role": "The access permission for the entity.",
			"selfLink": "The link to this access-control entry."
		}
	],
	"billing": {
		"requesterPays": false
	},
	"cors": [
		{
			"maxAgeSeconds": 0,
			"method": [
				"string"
			],
			"origin": [
				"string"
			],
			"responseHeader": [
				"string"
			]
		}
	],
	"customPlacementConfig": {
		"dataLocations": [
			"string"
		]
	},
	"defaultEventBasedHold": false,
	"defaultObjectAcl": [
		{
			"bucket": "The name of the bucket.",
			"domain": "The domain associated with the entity, if any.",
			"email": "The email address associated with the entity, if any.",
			"entity": "The entity holding the permission, in one of the following forms:\n- user-userId\n- user-email\n- group-groupId\n- group-email\n- domain-domain\n- project-team-projectId\n- allUsers\n- allAuthenticatedUsers Examples:\n- The user liz@example.com would be user-liz@example.com.\n- The group example@googlegroups.com would be group-example@googlegroups.com.\n- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.",
			"entityId": "The ID for the entity, if any.",
			"etag": "HTTP 1.1 Entity tag for the access-control entry.",
			"generation": "The content generation of the object, if applied to an object.",
			"id": "The ID of the access-control entry.",
			"kind": "storage#objectAccessControl",
			"object": "The name of the object, if applied to an object.",
			"projectTeam": {
				"projectNumber": "The project number.",
				"team": "The team."
			},
			"role": "The access permission for the entity.",
			"selfLink": "The link to this access-control entry."
		}
	],
	"encryption": {
		"defaultKmsKeyName": "A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified."
	},
	"etag": "HTTP 1.1 Entity tag for the bucket.",
	"iamConfiguration": {
		"bucketPolicyOnly": {
			"enabled": false,
			"lockedTime": "The 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."
		},
		"publicAccessPrevention": "The bucket's Public Access Prevention configuration. Currently, 'unspecified' and 'enforced' are supported.",
		"uniformBucketLevelAccess": {
			"enabled": false,
			"lockedTime": "The 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."
		}
	},
	"id": "The ID of the bucket. For buckets, the id and name properties are the same.",
	"kind": "storage#bucket",
	"labels": {},
	"lifecycle": {
		"rule": [
			{
				"action": {
					"storageClass": "Target storage class. Required iff the type of the action is SetStorageClass.",
					"type": "Type of the action. Currently, only Delete and SetStorageClass are supported."
				},
				"condition": {
					"age": 0,
					"createdBefore": "A date in RFC 3339 format with only the date part (for instance, \"2013-01-15\"). This condition is satisfied when an object is created before midnight of the specified date in UTC.",
					"customTimeBefore": "A date in RFC 3339 format with only the date part (for instance, \"2013-01-15\"). This condition is satisfied when the custom time on an object is before this date in UTC.",
					"daysSinceCustomTime": 0,
					"daysSinceNoncurrentTime": 0,
					"isLive": false,
					"matchesPattern": "A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the \"Early Access\" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released.",
					"matchesStorageClass": [
						"string"
					],
					"noncurrentTimeBefore": "A date in RFC 3339 format with only the date part (for instance, \"2013-01-15\"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects.",
					"numNewerVersions": 0
				}
			}
		]
	},
	"location": "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.",
	"locationType": "The type of the bucket location.",
	"logging": {
		"logBucket": "The destination bucket where the current bucket's logs should be placed.",
		"logObjectPrefix": "A prefix for log object names."
	},
	"metageneration": "The metadata generation of this bucket.",
	"name": "The name of the bucket.",
	"owner": {
		"entity": "The entity, in the form project-owner-projectId.",
		"entityId": "The ID for the entity."
	},
	"projectNumber": "The project number of the project the bucket belongs to.",
	"retentionPolicy": {
		"effectiveTime": "Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.",
		"isLocked": false,
		"retentionPeriod": "The 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."
	},
	"rpo": "The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.",
	"satisfiesPZS": false,
	"selfLink": "The URI of this bucket.",
	"storageClass": "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.",
	"timeCreated": "The creation time of the bucket in RFC 3339 format.",
	"updated": "The modification time of the bucket in RFC 3339 format.",
	"versioning": {
		"enabled": false
	},
	"website": {
		"mainPageSuffix": "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.",
		"notFoundPage": "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."
	}
}