CreateBucket
Create a GCS bucket or update if it already exists.
type: "io.kestra.plugin.gcp.gcs.CreateBucket"Examples
Create a new bucket with some options
id: gcp_gcs_create_bucket
namespace: company.team
tasks:
- id: create_bucket
type: io.kestra.plugin.gcp.gcs.CreateBucket
name: "my-bucket"
versioningEnabled: true
labels:
my-label: my-value
Properties
name*Requiredstring
Bucket's unique name
aclNon-dynamicarray
The bucket's access control configuration
io.kestra.plugin.gcp.gcs.models.AccessControl
io.kestra.plugin.gcp.gcs.models.Entity
DOMAINGROUPUSERREADERWRITEROWNERcorsNon-dynamicarray
The bucket's Cross-Origin Resource Sharing (CORS) configuration
io.kestra.plugin.gcp.gcs.models.Cors
GETHEADPUTPOSTDELETEOPTIONScom.google.cloud.storage.Cors-Origin
defaultAclNon-dynamicarray
The default access control configuration
The access control configuration to apply to bucket's blobs when no other configuration is specified. See About Access Control Lists
io.kestra.plugin.gcp.gcs.models.AccessControl
The entity
io.kestra.plugin.gcp.gcs.models.Entity
DOMAINGROUPUSERThe type of the entity (USER, GROUP or DOMAIN)
The value for the entity (ex : user email if the type is USER ...)
READERWRITEROWNERThe role to assign to the entity
defaultEventBasedHoldbooleanstring
The default event-based hold for this bucket
defaultKmsKeyNamestring
The default Cloud KMS key name for this bucket
iamConfigurationNon-dynamic
The Bucket's IAM Configuration
io.kestra.plugin.gcp.gcs.models.IamConfiguration
ENFORCEDUNSPECIFIEDUNKNOWNINHERITEDifExistsstring
ERRORERRORUPDATESKIPPolicy to apply if a bucket already exists.
impersonatedServiceAccountstring
The GCP service account to impersonate.
indexPagestring
The bucket's website index page
Behaves as the bucket's directory index where missing blobs are treated as potential directories.
labelsobject
The labels of this bucket
lifecycleRulesNon-dynamicarray
The bucket's lifecycle configuration
This configuration is expressed as a number of lifecycle rules, consisting of an action and a condition. See Object Lifecycle Management Only the age condition is supported. Only the delete and SetStorageClass actions are supported
io.kestra.plugin.gcp.gcs.models.BucketLifecycleRule
The action to take when a lifecycle condition is met
io.kestra.plugin.gcp.gcs.models.BucketLifecycleRule-Action
DELETESET_STORAGE_CLASSThe type of the action (DELETE ...)
The value for the action (if any)
The condition
io.kestra.plugin.gcp.gcs.models.BucketLifecycleRule-Condition
The Age condition is satisfied when an object reaches the specified age (in days). Age is measured from the object's creation time.
locationstring
Data for blobs in the bucket resides in physical storage within this region. A list of supported values is available here.
loggingNon-dynamic
The bucket's logging configuration
This configuration defines the destination bucket and optional name prefix for the current bucket's logs.
io.kestra.plugin.gcp.gcs.models.Logging
notFoundPagestring
The custom object to return when a requested resource is not found
projectIdstring
The GCP project ID.
requesterPaysbooleanstring
Whether the requester pays or not.
Whether a user accessing the bucket or an object it contains should assume the transit costs related to the access.
retentionPeriodintegerstring
Retention period
If policy is not locked this value can be cleared, increased, and decreased. If policy is locked the retention period can only be increased.
scopesarray
["https://www.googleapis.com/auth/cloud-platform"]The GCP scopes to be used.
serviceAccountstring
The GCP service account.
storageClassstring
REGIONALMULTI_REGIONALNEARLINECOLDLINESTANDARDARCHIVEDURABLE_REDUCED_AVAILABILITYThe bucket's storage class
This defines how blobs in the bucket are stored and determines the SLA and the cost of storage. A list of supported values is available here.
versioningEnabledbooleanstring
Whether versioning should be enabled for this bucket
When set to true, versioning is fully enabled.
Outputs
bucket
The bucket's info
io.kestra.plugin.gcp.gcs.models.Bucket
The bucket's website index page.
The bucket's location
The bucket's unique name
The custom object to return when a requested resource is not found.
uriThe bucket's URI.
createdboolean
falseIf the bucket was created.
updatedboolean
falseIf the bucket was updated.
