Create a dual-region bucket

Create a dual-region bucket

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 
&  
 region_a 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 region_b 
 ) 
  
 { 
  
 auto 
  
 metadata 
  
 = 
  
 client 
 . 
 CreateBucket 
 ( 
  
 bucket_name 
 , 
  
 gcs 
 :: 
 BucketMetadata 
 (). 
 set_custom_placement_config 
 ( 
  
 gcs 
 :: 
 BucketCustomPlacementConfig 
{{region_a, region_b} })); 
  
 if 
  
 ( 
 ! 
 metadata 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 metadata 
 ). 
 status 
 (); 
  
 std 
 :: 
 cout 
 << 
 "Bucket " 
 << 
 metadata 
 - 
> name 
 () 
 << 
 " created." 
 << 
 " 
 \n 
 Full Metadata: " 
 << 
 * 
 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 
  
 CreateDualRegionBucketSample 
 { 
  
 public 
  
 Bucket 
  
 CreateDualRegionBucket 
 ( 
  
 string 
  
 projectId 
  
 = 
  
 "your-project-id" 
 , 
  
 string 
  
 bucketName 
  
 = 
  
 "your-unique-bucket-name" 
 , 
  
 string 
  
 location 
  
 = 
  
 "your-location" 
 , 
  
 string 
  
 region1 
  
 = 
  
 "your-region1-name" 
 , 
  
 string 
  
 region2 
  
 = 
  
 "your-region2-name" 
 ) 
  
 { 
  
 var 
  
 client 
  
 = 
  
  StorageClient 
 
 . 
  Create 
 
 (); 
  
 var 
  
 bucket 
  
 = 
  
 new 
  
 Bucket 
  
 { 
  
 Name 
  
 = 
  
 bucketName 
 , 
  
 Location 
  
 = 
  
 location 
 , 
  
 CustomPlacementConfig 
  
 = 
  
 new 
  
 Bucket 
 . 
 CustomPlacementConfigData 
  
 { 
  
 DataLocations 
  
 = 
  
 new 
 [] 
  
 { 
  
 region1 
 , 
  
 region2 
  
 } 
  
 } 
  
 }; 
  
 var 
  
 storageBucket 
  
 = 
  
 client 
 . 
 CreateBucket 
 ( 
 projectId 
 , 
  
 bucket 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Created storage bucket {storageBucket.Name}" 
  
 + 
  
 $" in {storageBucket.Location}" 
  
 + 
  
 $" with location-type {storageBucket.LocationType} and" 
  
 + 
  
 $" dataLocations {string.Join(" 
 , 
 ", storageBucket.CustomPlacementConfig.DataLocations)}." 
 ); 
  
 return 
  
 storageBucket 
 ; 
  
 } 
 } 
 

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" 
 ) 
 // createBucketDualRegion creates a new dual-region bucket in the project in the 
 // provided location and regions. 
 // See https://cloud.google.com/storage/docs/locations#location-dr for more information. 
 func 
  
 createBucketDualRegion 
 ( 
 w 
  
 io 
 . 
  Writer 
 
 , 
  
 projectID 
 , 
  
 bucketName 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "my-project-id" 
  
 // bucketName := "bucket-name" 
  
 location 
  
 := 
  
 "US" 
  
 region1 
  
 := 
  
 "US-EAST1" 
  
 region2 
  
 := 
  
 "US-WEST1" 
  
 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 
 () 
  
 storageDualRegion 
  
 := 
  
& storage 
 . 
  BucketAttrs 
 
 { 
  
 Location 
 : 
  
 location 
 , 
  
 CustomPlacementConfig 
 : 
  
& storage 
 . 
  CustomPlacementConfig 
 
 { 
  
 DataLocations 
 : 
  
 [] 
 string 
 { 
 region1 
 , 
  
 region2 
 }, 
  
 }, 
  
 } 
  
 bucket 
  
 := 
  
 client 
 . 
  Bucket 
 
 ( 
 bucketName 
 ) 
  
 if 
  
 err 
  
 := 
  
 bucket 
 . 
  Create 
 
 ( 
 ctx 
 , 
  
 projectID 
 , 
  
 storageDualRegion 
 ); 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "Bucket(%q).Create: %w" 
 , 
  
 bucketName 
 , 
  
 err 
 ) 
  
 } 
  
 attrs 
 , 
  
 err 
  
 := 
  
 bucket 
 . 
 Attrs 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "Bucket(%q).Attrs: %w" 
 , 
  
 bucketName 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Created bucket %v" 
 , 
  
 bucketName 
 ) 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 " - location: %v" 
 , 
  
 attrs 
 . 
 Location 
 ) 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 " - locationType: %v" 
 , 
  
 attrs 
 . 
 LocationType 
 ) 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 " - customPlacementConfig.dataLocations: %v" 
 , 
  
 attrs 
 . 
  CustomPlacementConfig 
 
 . 
 DataLocations 
 ) 
  
 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. BucketInfo 
. CustomPlacementConfig 
 
 ; 
 import 
  
 com.google.cloud.storage. Storage 
 
 ; 
 import 
  
 com.google.cloud.storage. StorageOptions 
 
 ; 
 import 
  
 java.util.Arrays 
 ; 
 public 
  
 class 
 CreateBucketDualRegion 
  
 { 
  
 public 
  
 static 
  
 void 
  
 createBucketDualRegion 
 ( 
  
 String 
  
 projectId 
 , 
  
 String 
  
 bucketName 
 , 
  
 String 
  
 location 
 , 
  
 String 
  
 firstRegion 
 , 
  
 String 
  
 secondRegion 
 ) 
  
 { 
  
 // The ID of your GCP project. 
  
 // String projectId = "your-project-id"; 
  
 // The ID to give your GCS bucket. 
  
 // String bucketName = "your-unique-bucket-name"; 
  
 // The location your dual regions will be located in. 
  
 // String location = "US"; 
  
 // One of the regions the dual region bucket is to be created in. 
  
 // String firstRegion = "US-EAST1"; 
  
 // The second region the dual region bucket is to be created in. 
  
 // String secondRegion = "US-WEST1"; 
  
 // See this documentation for other valid locations and regions: 
  
 // https://cloud.google.com/storage/docs/locations 
  
  Storage 
 
  
 storage 
  
 = 
  
  StorageOptions 
 
 . 
 newBuilder 
 (). 
 setProjectId 
 ( 
 projectId 
 ). 
 build 
 (). 
  getService 
 
 (); 
  
  CustomPlacementConfig 
 
  
 config 
  
 = 
  
  CustomPlacementConfig 
 
 . 
 newBuilder 
 () 
  
 . 
  setDataLocations 
 
 ( 
 Arrays 
 . 
 asList 
 ( 
 firstRegion 
 , 
  
 secondRegion 
 )) 
  
 . 
 build 
 (); 
  
  BucketInfo 
 
  
 bucketInfo 
  
 = 
  
  BucketInfo 
 
 . 
 newBuilder 
 ( 
 bucketName 
 ) 
  
 . 
 setLocation 
 ( 
 location 
 ) 
  
 . 
 setCustomPlacementConfig 
 ( 
 config 
 ) 
  
 . 
 build 
 (); 
  
  Bucket 
 
  
 bucket 
  
 = 
  
 storage 
 . 
  create 
 
 ( 
 bucketInfo 
 ); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
  
 "Created bucket " 
  
 + 
  
 bucket 
 . 
 getName 
 () 
  
 + 
  
 " in location " 
  
 + 
  
 bucket 
 . 
 getLocation 
 () 
  
 + 
  
 " with location type " 
  
 + 
  
 bucket 
 . 
  getLocationType 
 
 () 
  
 + 
  
 " with Custom Placement Config " 
  
 + 
  
 bucket 
 . 
  getCustomPlacementConfig 
 
 (). 
 toString 
 ()); 
  
 } 
 } 
 

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 bucket's pair of regions. Case-insensitive. 
 // See this documentation for other valid locations: 
 // https://cloud.google.com/storage/docs/locations 
 // const location = 'US'; 
 // const region1 = 'US-EAST1'; 
 // const region2 = 'US-WEST1'; 
 // 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 
  
 createDualRegionBucket 
 () 
  
 { 
  
 // For regions supporting dual-regions see: https://cloud.google.com/storage/docs/locations 
  
 const 
  
 [ 
 bucket 
 ] 
  
 = 
  
 await 
  
 storage 
 . 
  createBucket 
 
 ( 
 bucketName 
 , 
  
 { 
  
 location 
 , 
  
 customPlacementConfig 
 : 
  
 { 
  
 dataLocations 
 : 
  
 [ 
 region1 
 , 
  
 region2 
 ], 
  
 }, 
  
 }); 
  
 console 
 . 
 log 
 ( 
 `Created ' 
 ${ 
 bucket 
 . 
 name 
 } 
 '` 
 ); 
  
 console 
 . 
 log 
 ( 
 `- location: ' 
 ${ 
 bucket 
 . 
 metadata 
 . 
 location 
 } 
 '` 
 ); 
  
 console 
 . 
 log 
 ( 
 `- locationType: ' 
 ${ 
 bucket 
 . 
 metadata 
 . 
 locationType 
 } 
 '` 
 ); 
  
 console 
 . 
 log 
 ( 
  
 `- customPlacementConfig: ' 
 ${ 
  JSON 
 
 . 
 stringify 
 ( 
  
 bucket 
 . 
 metadata 
 . 
 customPlacementConfig 
  
 ) 
 } 
 '` 
  
 ); 
 } 
 createDualRegionBucket 
 (). 
 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') 
 * @param string $location Location for the bucket's regions. Case-insensitive. 
 *        (e.g. 'US') 
 * @param string $region1 First region for the bucket's regions. Case-insensitive. 
 *        (e.g. 'US-EAST1') 
 * @param string $region2 Second region for the bucket's regions. Case-insensitive. 
 *        (e.g. 'US-WEST1') 
 */ 
 function create_bucket_dual_region(string $bucketName, string $location, string $region1, string $region2): void 
 { 
 $storage = new StorageClient(); 
 $bucket = $storage->createBucket($bucketName, [ 
 'location' => $location, 
 'customPlacementConfig' => [ 
 'dataLocations' => [$region1, $region2], 
 ], 
 ]); 
 $info = $bucket->info(); 
 printf("Created '%s':", $bucket->name()); 
 printf("- location: '%s'", $info['location']); 
 printf("- locationType: '%s'", $info['locationType']); 
 printf("- customPlacementConfig: '%s'" . PHP_EOL, print_r($info['customPlacementConfig'], true)); 
 } 
 

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_dual_region 
 ( 
 bucket_name 
 , 
 location 
 , 
 region_1 
 , 
 region_2 
 ): 
  
 """Creates a Dual-Region Bucket with provided location and regions..""" 
 # The ID of your GCS bucket 
 # bucket_name = "your-bucket-name" 
 # The bucket's pair of regions. Case-insensitive. 
 # See this documentation for other valid locations: 
 # https://cloud.google.com/storage/docs/locations 
 # region_1 = "US-EAST1" 
 # region_2 = "US-WEST1" 
 # location = "US" 
 storage_client 
 = 
  storage 
 
 . 
  Client 
 
 () 
 bucket 
 = 
 storage_client 
 . 
  create_bucket 
 
 ( 
 bucket_name 
 , 
 location 
 = 
 location 
 , 
 data_locations 
 = 
 [ 
 region_1 
 , 
 region_2 
 ]) 
 print 
 ( 
 f 
 "Created bucket 
 { 
 bucket_name 
 } 
 " 
 ) 
 print 
 ( 
 f 
 " - location: 
 { 
 bucket 
 . 
  location 
 
 } 
 " 
 ) 
 print 
 ( 
 f 
 " - location_type: 
 { 
 bucket 
 . 
  location_type 
 
 } 
 " 
 ) 
 print 
 ( 
 f 
 " - customPlacementConfig data_locations: 
 { 
 bucket 
 . 
  data_locations 
 
 } 
 " 
 ) 
 

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 .

  # The ID of your GCS bucket 
 # bucket_name = "your-bucket-name" 
 # The bucket's pair of regions. Case-insensitive. 
 # See this documentation for other valid locations: 
 # https://cloud.google.com/storage/docs/locations 
 # region_1 = "US-EAST1" 
 # region_2 = "US-WEST1" 
 require 
  
 "google/cloud/storage" 
 storage 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
  Storage 
 
 . 
  new 
 
 bucket 
  
 = 
  
 storage 
 . 
  create_bucket 
 
  
 bucket_name 
 , 
  
 custom_placement_config 
 : 
  
 { 
  
 data_locations 
 : 
  
 [ 
 region_1 
 , 
  
 region_2 
 ] 
  
 } 
 puts 
  
 "Bucket 
 #{ 
 bucket 
 . 
 name 
 } 
 created:" 
 puts 
  
 "- location: 
 #{ 
 bucket 
 . 
 location 
 } 
 " 
 puts 
  
 "- location_type: 
 #{ 
 bucket 
 . 
 location_type 
 } 
 " 
 puts 
  
 "- custom_placement_config:" 
 puts 
  
 "  - data_locations: 
 #{ 
 bucket 
 . 
 data_locations 
 } 
 " 
 

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: