Create a bucket with options

Create a Cloud Storage bucket with storage class and location parameters.

Explore further

For detailed documentation that includes this code sample, see the following:

Code sample

C++

For more information, see the Cloud Storage C++ API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  namespace 
  
 gcs 
  
 = 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 storage 
 ; 
 using 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 StatusOr 
 ; 
 []( 
 gcs 
 :: 
 Client 
  
 client 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 bucket_name 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 storage_class 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 location 
 ) 
  
 { 
  
 StatusOr<gcs 
 :: 
 BucketMetadata 
>  
 bucket_metadata 
  
 = 
  
 client 
 . 
 CreateBucket 
 ( 
 bucket_name 
 , 
  
 gcs 
 :: 
 BucketMetadata 
 () 
  
 . 
 set_storage_class 
 ( 
 storage_class 
 ) 
  
 . 
 set_location 
 ( 
 location 
 )); 
  
 if 
  
 ( 
 ! 
 bucket_metadata 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 bucket_metadata 
 ). 
 status 
 (); 
  
 std 
 :: 
 cout 
 << 
 "Bucket " 
 << 
 bucket_metadata 
 - 
> name 
 () 
 << 
 " created." 
 << 
 " 
 \n 
 Full Metadata: " 
 << 
 * 
 bucket_metadata 
 << 
 " 
 \n 
 " 
 ; 
 } 
 

C#

For more information, see the Cloud Storage C# API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  using 
  
 Google.Apis.Storage.v1.Data 
 ; 
 using 
  
  Google.Cloud.Storage.V1 
 
 ; 
 using 
  
 System 
 ; 
 public 
  
 class 
  
 CreateRegionalBucketSample 
 { 
  
 /// <summary> 
  
 /// Creates a storage bucket with region. 
  
 /// </summary> 
  
 /// <param name="projectId">The ID of the project to create the buckets in.</param> 
  
 /// <param name="location">The location of the bucket. Object data for objects in the bucket resides in 
  
 /// physical storage within this region. Defaults to US.</param> 
  
 /// <param name="bucketName">The name of the bucket to create.</param> 
  
 /// <param name="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.</param> 
  
 public 
  
 Bucket 
  
 CreateRegionalBucket 
 ( 
  
 string 
  
 projectId 
  
 = 
  
 "your-project-id" 
 , 
  
 string 
  
 bucketName 
  
 = 
  
 "your-unique-bucket-name" 
 , 
  
 string 
  
 location 
  
 = 
  
 "us-west1" 
 , 
  
 string 
  
 storageClass 
  
 = 
  
 "REGIONAL" 
 ) 
  
 { 
  
 var 
  
 storage 
  
 = 
  
  StorageClient 
 
 . 
  Create 
 
 (); 
  
 Bucket 
  
 bucket 
  
 = 
  
 new 
  
 Bucket 
  
 { 
  
 Location 
  
 = 
  
 location 
 , 
  
 Name 
  
 = 
  
 bucketName 
 , 
  
 StorageClass 
  
 = 
  
 storageClass 
  
 }; 
  
 var 
  
 newlyCreatedBucket 
  
 = 
  
 storage 
 . 
 CreateBucket 
 ( 
 projectId 
 , 
  
 bucket 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Created {bucketName}." 
 ); 
  
 return 
  
 newlyCreatedBucket 
 ; 
  
 } 
 } 
 

Go

For more information, see the Cloud Storage Go API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 "time" 
  
 "cloud.google.com/go/storage" 
 ) 
 // createBucketClassLocation creates a new bucket in the project with Storage class and 
 // location. 
 func 
  
 createBucketClassLocation 
 ( 
 w 
  
 io 
 . 
  Writer 
 
 , 
  
 projectID 
 , 
  
 bucketName 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "my-project-id" 
  
 // bucketName := "bucket-name" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 storage 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "storage.NewClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 ctx 
 , 
  
 cancel 
  
 := 
  
 context 
 . 
 WithTimeout 
 ( 
 ctx 
 , 
  
 time 
 . 
 Second 
 * 
 30 
 ) 
  
 defer 
  
 cancel 
 () 
  
 storageClassAndLocation 
  
 := 
  
& storage 
 . 
  BucketAttrs 
 
 { 
  
 StorageClass 
 : 
  
 "COLDLINE" 
 , 
  
 Location 
 : 
  
 "asia" 
 , 
  
 } 
  
 bucket 
  
 := 
  
 client 
 . 
  Bucket 
 
 ( 
 bucketName 
 ) 
  
 if 
  
 err 
  
 := 
  
 bucket 
 . 
  Create 
 
 ( 
 ctx 
 , 
  
 projectID 
 , 
  
 storageClassAndLocation 
 ); 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "Bucket(%q).Create: %w" 
 , 
  
 bucketName 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Created bucket %v in %v with storage class %v\n" 
 , 
  
 bucketName 
 , 
  
 storageClassAndLocation 
 . 
 Location 
 , 
  
 storageClassAndLocation 
 . 
 StorageClass 
 ) 
  
 return 
  
 nil 
 } 
 

Java

For more information, see the Cloud Storage Java API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  import 
  
 com.google.cloud.storage. Bucket 
 
 ; 
 import 
  
 com.google.cloud.storage. BucketInfo 
 
 ; 
 import 
  
 com.google.cloud.storage. Storage 
 
 ; 
 import 
  
 com.google.cloud.storage. StorageClass 
 
 ; 
 import 
  
 com.google.cloud.storage. StorageOptions 
 
 ; 
 public 
  
 class 
 CreateBucketWithStorageClassAndLocation 
  
 { 
  
 public 
  
 static 
  
 void 
  
 createBucketWithStorageClassAndLocation 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 bucketName 
 ) 
  
 { 
  
 // The ID of your GCP project 
  
 // String projectId = "your-project-id"; 
  
 // The ID to give your GCS bucket 
  
 // String bucketName = "your-unique-bucket-name"; 
  
  Storage 
 
  
 storage 
  
 = 
  
  StorageOptions 
 
 . 
 newBuilder 
 (). 
 setProjectId 
 ( 
 projectId 
 ). 
 build 
 (). 
  getService 
 
 (); 
  
 // See the StorageClass documentation for other valid storage classes: 
  
 // https://googleapis.dev/java/google-cloud-clients/latest/com/google/cloud/storage/StorageClass.html 
  
  StorageClass 
 
  
 storageClass 
  
 = 
  
  StorageClass 
 
 . 
 COLDLINE 
 ; 
  
 // See this documentation for other valid locations: 
  
 // http://g.co/cloud/storage/docs/bucket-locations#location-mr 
  
 String 
  
 location 
  
 = 
  
 "ASIA" 
 ; 
  
  Bucket 
 
  
 bucket 
  
 = 
  
 storage 
 . 
  create 
 
 ( 
  
 BucketInfo 
 . 
 newBuilder 
 ( 
 bucketName 
 ) 
  
 . 
 setStorageClass 
 ( 
 storageClass 
 ) 
  
 . 
 setLocation 
 ( 
 location 
 ) 
  
 . 
 build 
 ()); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
  
 "Created bucket " 
  
 + 
  
 bucket 
 . 
 getName 
 () 
  
 + 
  
 " in " 
  
 + 
  
 bucket 
 . 
 getLocation 
 () 
  
 + 
  
 " with storage class " 
  
 + 
  
 bucket 
 . 
 getStorageClass 
 ()); 
  
 } 
 } 
 

Node.js

For more information, see the Cloud Storage Node.js API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  /** 
 * TODO(developer): Uncomment the following lines before running the sample. 
 */ 
 // The ID of your GCS bucket 
 // const bucketName = 'your-unique-bucket-name'; 
 // The name of a storage class 
 // See the StorageClass documentation for other valid storage classes: 
 // https://googleapis.dev/java/google-cloud-clients/latest/com/google/cloud/storage/StorageClass.html 
 // const storageClass = 'coldline'; 
 // The name of a location 
 // See this documentation for other valid locations: 
 // http://g.co/cloud/storage/docs/locations#location-mr 
 // const location = 'ASIA'; 
 // Imports the Google Cloud client library 
 const 
  
 { 
 Storage 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/storage 
' 
 ); 
 // Creates a client 
 // The bucket in the sample below will be created in the project associated with this client. 
 // For more information, please see https://cloud.google.com/docs/authentication/production or https://googleapis.dev/nodejs/storage/latest/Storage.html 
 const 
  
 storage 
  
 = 
  
 new 
  
 Storage 
 (); 
 async 
  
 function 
  
 createBucketWithStorageClassAndLocation 
 () 
  
 { 
  
 // For default values see: https://cloud.google.com/storage/docs/locations and 
  
 // https://cloud.google.com/storage/docs/storage-classes 
  
 const 
  
 [ 
 bucket 
 ] 
  
 = 
  
 await 
  
 storage 
 . 
  createBucket 
 
 ( 
 bucketName 
 , 
  
 { 
  
 location 
 , 
  
 [ 
 storageClass 
 ] 
 : 
  
 true 
 , 
  
 }); 
  
 console 
 . 
 log 
 ( 
  
 ` 
 ${ 
 bucket 
 . 
 name 
 } 
 created with 
 ${ 
 storageClass 
 } 
 class in 
 ${ 
 location 
 } 
 ` 
  
 ); 
 } 
 createBucketWithStorageClassAndLocation 
 (). 
 catch 
 ( 
 console 
 . 
 error 
 ); 
 

PHP

For more information, see the Cloud Storage PHP API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  use Google\Cloud\Storage\StorageClient; 
 /** 
 * Create a new bucket with a custom default storage class and location. 
 * 
 * @param string $bucketName The name of your Cloud Storage bucket. 
 *        (e.g. 'my-bucket') 
 */ 
 function create_bucket_class_location(string $bucketName): void 
 { 
 $storage = new StorageClient(); 
 $storageClass = 'COLDLINE'; 
 $location = 'ASIA'; 
 $bucket = $storage->createBucket($bucketName, [ 
 'storageClass' => $storageClass, 
 'location' => $location, 
 ]); 
 $objects = $bucket->objects([ 
 'encryption' => [ 
 'defaultKmsKeyName' => null, 
 ] 
 ]); 
 printf('Created bucket %s in %s with storage class %s', $bucketName, $storageClass, $location); 
 } 
 

Python

For more information, see the Cloud Storage Python API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  from 
  
 google.cloud 
  
 import 
  storage 
 
 def 
  
 create_bucket_class_location 
 ( 
 bucket_name 
 ): 
  
 """ 
 Create a new bucket in the US region with the coldline storage 
 class 
 """ 
 # bucket_name = "your-new-bucket-name" 
 storage_client 
 = 
  storage 
 
 . 
  Client 
 
 () 
 bucket 
 = 
 storage_client 
 . 
  bucket 
 
 ( 
 bucket_name 
 ) 
 bucket 
 . 
 storage_class 
 = 
 "COLDLINE" 
 new_bucket 
 = 
 storage_client 
 . 
  create_bucket 
 
 ( 
 bucket 
 , 
 location 
 = 
 "us" 
 ) 
 print 
 ( 
 "Created bucket 
 {} 
 in 
 {} 
 with storage class 
 {} 
 " 
 . 
 format 
 ( 
 new_bucket 
 . 
 name 
 , 
 new_bucket 
 . 
  location 
 
 , 
 new_bucket 
 . 
 storage_class 
 ) 
 ) 
 return 
 new_bucket 
 

Ruby

For more information, see the Cloud Storage Ruby API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  def 
  
 create_bucket_class_location 
  
 bucket_name 
 : 
  
 # The ID to give your GCS bucket 
  
 # bucket_name = "your-unique-bucket-name" 
  
 require 
  
 "google/cloud/storage" 
  
 storage 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
  Storage 
 
 . 
  new 
 
  
 bucket 
  
 = 
  
 storage 
 . 
  create_bucket 
 
  
 bucket_name 
 , 
  
 location 
 : 
  
 "ASIA" 
 , 
  
 storage_class 
 : 
  
 "COLDLINE" 
  
 puts 
  
 "Created bucket 
 #{ 
 bucket 
 . 
 name 
 } 
 in 
 #{ 
 bucket 
 . 
 location 
 } 
 with 
 #{ 
 bucket 
 . 
 storage_class 
 } 
 class" 
 end 
 

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .

Create a Mobile Website
View Site in Mobile | Classic
Share by: