Viewing docs for Google Cloud v9.23.0
published on Thursday, May 7, 2026 by Pulumi
published on Thursday, May 7, 2026 by Pulumi
Viewing docs for Google Cloud v9.23.0
published on Thursday, May 7, 2026 by Pulumi
published on Thursday, May 7, 2026 by Pulumi
Gets an existing bucket in Google Cloud Storage service (GCS). See the official documentation and API.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const my_bucket = gcp.storage.getBucket({
name: "my-bucket",
});
import pulumi
import pulumi_gcp as gcp
my_bucket = gcp.storage.get_bucket(name="my-bucket")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/storage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := storage.LookupBucket(ctx, &storage.LookupBucketArgs{
Name: "my-bucket",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var my_bucket = Gcp.Storage.GetBucket.Invoke(new()
{
Name = "my-bucket",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.StorageFunctions;
import com.pulumi.gcp.storage.inputs.GetBucketArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var my-bucket = StorageFunctions.getBucket(GetBucketArgs.builder()
.name("my-bucket")
.build());
}
}
variables:
my-bucket:
fn::invoke:
function: gcp:storage:getBucket
arguments:
name: my-bucket
Example coming soon!
Using getBucket
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getBucket(args: GetBucketArgs, opts?: InvokeOptions): Promise<GetBucketResult>
function getBucketOutput(args: GetBucketOutputArgs, opts?: InvokeOptions): Output<GetBucketResult>def get_bucket(name: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetBucketResult
def get_bucket_output(name: pulumi.Input[Optional[str]] = None,
project: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetBucketResult]func LookupBucket(ctx *Context, args *LookupBucketArgs, opts ...InvokeOption) (*LookupBucketResult, error)
func LookupBucketOutput(ctx *Context, args *LookupBucketOutputArgs, opts ...InvokeOption) LookupBucketResultOutput> Note: This function is named LookupBucket in the Go SDK.
public static class GetBucket
{
public static Task<GetBucketResult> InvokeAsync(GetBucketArgs args, InvokeOptions? opts = null)
public static Output<GetBucketResult> Invoke(GetBucketInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetBucketResult> getBucket(GetBucketArgs args, InvokeOptions options)
public static Output<GetBucketResult> getBucket(GetBucketArgs args, InvokeOptions options)
fn::invoke:
function: gcp:storage/getBucket:getBucket
arguments:
# arguments dictionarydata "gcp_storage_getbucket" "name" {
# arguments
}The following arguments are supported:
- Name string
- The name of the bucket.
- Project string
- The ID of the project in which the resource belongs. If it is not provided then the data source will use the Compute API to find the project id that corresponds to the project number returned from the Storage API, and if no Compute API permissions are available or if the Compute API is disabled it defaults to the provider value. Supplying a value for
projectdoesn't influence retrieving data about the bucket but it can be used to prevent use of the Compute API. If you do provide aprojectvalue ensure that it is the correct value for that bucket; the data source will not check that the project id and project number match.
- Name string
- The name of the bucket.
- Project string
- The ID of the project in which the resource belongs. If it is not provided then the data source will use the Compute API to find the project id that corresponds to the project number returned from the Storage API, and if no Compute API permissions are available or if the Compute API is disabled it defaults to the provider value. Supplying a value for
projectdoesn't influence retrieving data about the bucket but it can be used to prevent use of the Compute API. If you do provide aprojectvalue ensure that it is the correct value for that bucket; the data source will not check that the project id and project number match.
- name string
- The name of the bucket.
- project string
- The ID of the project in which the resource belongs. If it is not provided then the data source will use the Compute API to find the project id that corresponds to the project number returned from the Storage API, and if no Compute API permissions are available or if the Compute API is disabled it defaults to the provider value. Supplying a value for
projectdoesn't influence retrieving data about the bucket but it can be used to prevent use of the Compute API. If you do provide aprojectvalue ensure that it is the correct value for that bucket; the data source will not check that the project id and project number match.
- name String
- The name of the bucket.
- project String
- The ID of the project in which the resource belongs. If it is not provided then the data source will use the Compute API to find the project id that corresponds to the project number returned from the Storage API, and if no Compute API permissions are available or if the Compute API is disabled it defaults to the provider value. Supplying a value for
projectdoesn't influence retrieving data about the bucket but it can be used to prevent use of the Compute API. If you do provide aprojectvalue ensure that it is the correct value for that bucket; the data source will not check that the project id and project number match.
- name string
- The name of the bucket.
- project string
- The ID of the project in which the resource belongs. If it is not provided then the data source will use the Compute API to find the project id that corresponds to the project number returned from the Storage API, and if no Compute API permissions are available or if the Compute API is disabled it defaults to the provider value. Supplying a value for
projectdoesn't influence retrieving data about the bucket but it can be used to prevent use of the Compute API. If you do provide aprojectvalue ensure that it is the correct value for that bucket; the data source will not check that the project id and project number match.
- name str
- The name of the bucket.
- project str
- The ID of the project in which the resource belongs. If it is not provided then the data source will use the Compute API to find the project id that corresponds to the project number returned from the Storage API, and if no Compute API permissions are available or if the Compute API is disabled it defaults to the provider value. Supplying a value for
projectdoesn't influence retrieving data about the bucket but it can be used to prevent use of the Compute API. If you do provide aprojectvalue ensure that it is the correct value for that bucket; the data source will not check that the project id and project number match.
- name String
- The name of the bucket.
- project String
- The ID of the project in which the resource belongs. If it is not provided then the data source will use the Compute API to find the project id that corresponds to the project number returned from the Storage API, and if no Compute API permissions are available or if the Compute API is disabled it defaults to the provider value. Supplying a value for
projectdoesn't influence retrieving data about the bucket but it can be used to prevent use of the Compute API. If you do provide aprojectvalue ensure that it is the correct value for that bucket; the data source will not check that the project id and project number match.
getBucket Result
The following output properties are available:
- Autoclasses
List<Get
Bucket Autoclass> - Cors
List<Get
Bucket Cor> - Custom
Placement List<GetConfigs Bucket Custom Placement Config> - Default
Event boolBased Hold - Effective
Labels Dictionary<string, string> - Enable
Object boolRetention - Encryptions
List<Get
Bucket Encryption> - Force
Destroy bool - Hierarchical
Namespaces List<GetBucket Hierarchical Namespace> - Id string
- The provider-assigned unique ID for this managed resource.
- Ip
Filters List<GetBucket Ip Filter> - Labels Dictionary<string, string>
- Lifecycle
Rules List<GetBucket Lifecycle Rule> - Location string
- Loggings
List<Get
Bucket Logging> - Name string
- Project
Number int - Public
Access stringPrevention - Pulumi
Labels Dictionary<string, string> - Requester
Pays bool - Retention
Policies List<GetBucket Retention Policy> - Rpo string
- Self
Link string - Soft
Delete List<GetPolicies Bucket Soft Delete Policy> - Storage
Class string - Time
Created string - Uniform
Bucket boolLevel Access - Updated string
- Url string
- Versionings
List<Get
Bucket Versioning> - Websites
List<Get
Bucket Website> - Project string
- Autoclasses
[]Get
Bucket Autoclass - Cors
[]Get
Bucket Cor - Custom
Placement []GetConfigs Bucket Custom Placement Config - Default
Event boolBased Hold - Effective
Labels map[string]string - Enable
Object boolRetention - Encryptions
[]Get
Bucket Encryption - Force
Destroy bool - Hierarchical
Namespaces []GetBucket Hierarchical Namespace - Id string
- The provider-assigned unique ID for this managed resource.
- Ip
Filters []GetBucket Ip Filter - Labels map[string]string
- Lifecycle
Rules []GetBucket Lifecycle Rule - Location string
- Loggings
[]Get
Bucket Logging - Name string
- Project
Number int - Public
Access stringPrevention - Pulumi
Labels map[string]string - Requester
Pays bool - Retention
Policies []GetBucket Retention Policy - Rpo string
- Self
Link string - Soft
Delete []GetPolicies Bucket Soft Delete Policy - Storage
Class string - Time
Created string - Uniform
Bucket boolLevel Access - Updated string
- Url string
- Versionings
[]Get
Bucket Versioning - Websites
[]Get
Bucket Website - Project string
- autoclasses list(object)
- cors list(object)
- custom_
placement_ list(object)configs - default_
event_ boolbased_ hold - effective_
labels map(string) - enable_
object_ boolretention - encryptions list(object)
- force_
destroy bool - hierarchical_
namespaces list(object) - id string
- The provider-assigned unique ID for this managed resource.
- ip_
filters list(object) - labels map(string)
- lifecycle_
rules list(object) - location string
- loggings list(object)
- name string
- project_
number number - public_
access_ stringprevention - pulumi_
labels map(string) - requester_
pays bool - retention_
policies list(object) - rpo string
- self_
link string - soft_
delete_ list(object)policies - storage_
class string - time_
created string - uniform_
bucket_ boollevel_ access - updated string
- url string
- versionings list(object)
- websites list(object)
- project string
- autoclasses
List<Get
Bucket Autoclass> - cors
List<Get
Bucket Cor> - custom
Placement List<GetConfigs Bucket Custom Placement Config> - default
Event BooleanBased Hold - effective
Labels Map<String,String> - enable
Object BooleanRetention - encryptions
List<Get
Bucket Encryption> - force
Destroy Boolean - hierarchical
Namespaces List<GetBucket Hierarchical Namespace> - id String
- The provider-assigned unique ID for this managed resource.
- ip
Filters List<GetBucket Ip Filter> - labels Map<String,String>
- lifecycle
Rules List<GetBucket Lifecycle Rule> - location String
- loggings
List<Get
Bucket Logging> - name String
- project
Number Integer - public
Access StringPrevention - pulumi
Labels Map<String,String> - requester
Pays Boolean - retention
Policies List<GetBucket Retention Policy> - rpo String
- self
Link String - soft
Delete List<GetPolicies Bucket Soft Delete Policy> - storage
Class String - time
Created String - uniform
Bucket BooleanLevel Access - updated String
- url String
- versionings
List<Get
Bucket Versioning> - websites
List<Get
Bucket Website> - project String
- autoclasses
Get
Bucket Autoclass[] - cors
Get
Bucket Cor[] - custom
Placement GetConfigs Bucket Custom Placement Config[] - default
Event booleanBased Hold - effective
Labels {[key: string]: string} - enable
Object booleanRetention - encryptions
Get
Bucket Encryption[] - force
Destroy boolean - hierarchical
Namespaces GetBucket Hierarchical Namespace[] - id string
- The provider-assigned unique ID for this managed resource.
- ip
Filters GetBucket Ip Filter[] - labels {[key: string]: string}
- lifecycle
Rules GetBucket Lifecycle Rule[] - location string
- loggings
Get
Bucket Logging[] - name string
- project
Number number - public
Access stringPrevention - pulumi
Labels {[key: string]: string} - requester
Pays boolean - retention
Policies GetBucket Retention Policy[] - rpo string
- self
Link string - soft
Delete GetPolicies Bucket Soft Delete Policy[] - storage
Class string - time
Created string - uniform
Bucket booleanLevel Access - updated string
- url string
- versionings
Get
Bucket Versioning[] - websites
Get
Bucket Website[] - project string
- autoclasses
Sequence[Get
Bucket Autoclass] - cors
Sequence[Get
Bucket Cor] - custom_
placement_ Sequence[Getconfigs Bucket Custom Placement Config] - default_
event_ boolbased_ hold - effective_
labels Mapping[str, str] - enable_
object_ boolretention - encryptions
Sequence[Get
Bucket Encryption] - force_
destroy bool - hierarchical_
namespaces Sequence[GetBucket Hierarchical Namespace] - id str
- The provider-assigned unique ID for this managed resource.
- ip_
filters Sequence[GetBucket Ip Filter] - labels Mapping[str, str]
- lifecycle_
rules Sequence[GetBucket Lifecycle Rule] - location str
- loggings
Sequence[Get
Bucket Logging] - name str
- project_
number int - public_
access_ strprevention - pulumi_
labels Mapping[str, str] - requester_
pays bool - retention_
policies Sequence[GetBucket Retention Policy] - rpo str
- self_
link str - soft_
delete_ Sequence[Getpolicies Bucket Soft Delete Policy] - storage_
class str - time_
created str - uniform_
bucket_ boollevel_ access - updated str
- url str
- versionings
Sequence[Get
Bucket Versioning] - websites
Sequence[Get
Bucket Website] - project str
- autoclasses List<Property Map>
- cors List<Property Map>
- custom
Placement List<Property Map>Configs - default
Event BooleanBased Hold - effective
Labels Map<String> - enable
Object BooleanRetention - encryptions List<Property Map>
- force
Destroy Boolean - hierarchical
Namespaces List<Property Map> - id String
- The provider-assigned unique ID for this managed resource.
- ip
Filters List<Property Map> - labels Map<String>
- lifecycle
Rules List<Property Map> - location String
- loggings List<Property Map>
- name String
- project
Number Number - public
Access StringPrevention - pulumi
Labels Map<String> - requester
Pays Boolean - retention
Policies List<Property Map> - rpo String
- self
Link String - soft
Delete List<Property Map>Policies - storage
Class String - time
Created String - uniform
Bucket BooleanLevel Access - updated String
- url String
- versionings List<Property Map>
- websites List<Property Map>
- project String
Supporting Types
GetBucketAutoclass
- Enabled bool
- While set to true, autoclass automatically transitions objects in your bucket to appropriate storage classes based on each object's access pattern.
- Terminal
Storage stringClass - The storage class that objects in the bucket eventually transition to if they are not read for a certain length of time. Supported values include: NEARLINE, ARCHIVE.
- Enabled bool
- While set to true, autoclass automatically transitions objects in your bucket to appropriate storage classes based on each object's access pattern.
- Terminal
Storage stringClass - The storage class that objects in the bucket eventually transition to if they are not read for a certain length of time. Supported values include: NEARLINE, ARCHIVE.
- enabled bool
- While set to true, autoclass automatically transitions objects in your bucket to appropriate storage classes based on each object's access pattern.
- terminal_
storage_ stringclass - The storage class that objects in the bucket eventually transition to if they are not read for a certain length of time. Supported values include: NEARLINE, ARCHIVE.
- enabled Boolean
- While set to true, autoclass automatically transitions objects in your bucket to appropriate storage classes based on each object's access pattern.
- terminal
Storage StringClass - The storage class that objects in the bucket eventually transition to if they are not read for a certain length of time. Supported values include: NEARLINE, ARCHIVE.
- enabled boolean
- While set to true, autoclass automatically transitions objects in your bucket to appropriate storage classes based on each object's access pattern.
- terminal
Storage stringClass - The storage class that objects in the bucket eventually transition to if they are not read for a certain length of time. Supported values include: NEARLINE, ARCHIVE.
- enabled bool
- While set to true, autoclass automatically transitions objects in your bucket to appropriate storage classes based on each object's access pattern.
- terminal_
storage_ strclass - The storage class that objects in the bucket eventually transition to if they are not read for a certain length of time. Supported values include: NEARLINE, ARCHIVE.
- enabled Boolean
- While set to true, autoclass automatically transitions objects in your bucket to appropriate storage classes based on each object's access pattern.
- terminal
Storage StringClass - The storage class that objects in the bucket eventually transition to if they are not read for a certain length of time. Supported values include: NEARLINE, ARCHIVE.
GetBucketCor
- Max
Age intSeconds - The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
- Methods List<string>
- The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".
- Origins List<string>
- The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
- Response
Headers List<string> - The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
- Max
Age intSeconds - The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
- Methods []string
- The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".
- Origins []string
- The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
- Response
Headers []string - The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
- max_
age_ numberseconds - The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
- methods list(string)
- The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".
- origins list(string)
- The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
- response_
headers list(string) - The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
- max
Age IntegerSeconds - The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
- methods List<String>
- The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".
- origins List<String>
- The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
- response
Headers List<String> - The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
- max
Age numberSeconds - The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
- methods string[]
- The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".
- origins string[]
- The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
- response
Headers string[] - The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
- max_
age_ intseconds - The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
- methods Sequence[str]
- The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".
- origins Sequence[str]
- The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
- response_
headers Sequence[str] - The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
- max
Age NumberSeconds - The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
- methods List<String>
- The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".
- origins List<String>
- The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
- response
Headers List<String> - The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
GetBucketCustomPlacementConfig
- Data
Locations List<string> - The list of individual regions that comprise a dual-region bucket. See the docs for a list of acceptable regions. Note: If any of the dataLocations changes, it will recreate the bucket.
- Data
Locations []string - The list of individual regions that comprise a dual-region bucket. See the docs for a list of acceptable regions. Note: If any of the dataLocations changes, it will recreate the bucket.
- data_
locations list(string) - The list of individual regions that comprise a dual-region bucket. See the docs for a list of acceptable regions. Note: If any of the dataLocations changes, it will recreate the bucket.
- data
Locations List<String> - The list of individual regions that comprise a dual-region bucket. See the docs for a list of acceptable regions. Note: If any of the dataLocations changes, it will recreate the bucket.
- data
Locations string[] - The list of individual regions that comprise a dual-region bucket. See the docs for a list of acceptable regions. Note: If any of the dataLocations changes, it will recreate the bucket.
- data_
locations Sequence[str] - The list of individual regions that comprise a dual-region bucket. See the docs for a list of acceptable regions. Note: If any of the dataLocations changes, it will recreate the bucket.
- data
Locations List<String> - The list of individual regions that comprise a dual-region bucket. See the docs for a list of acceptable regions. Note: If any of the dataLocations changes, it will recreate the bucket.
GetBucketEncryption
- Customer
Managed List<GetEncryption Enforcement Configs Bucket Encryption Customer Managed Encryption Enforcement Config> - If omitted, then new objects with CMEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- Customer
Supplied List<GetEncryption Enforcement Configs Bucket Encryption Customer Supplied Encryption Enforcement Config> - If omitted, then new objects with CSEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- Default
Kms stringKey Name - A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. You must pay attention to whether the crypto key is available in the location that this bucket is created in. See the docs for more details.
- Google
Managed List<GetEncryption Enforcement Configs Bucket Encryption Google Managed Encryption Enforcement Config> - If omitted, then new objects with GMEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- Customer
Managed []GetEncryption Enforcement Configs Bucket Encryption Customer Managed Encryption Enforcement Config - If omitted, then new objects with CMEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- Customer
Supplied []GetEncryption Enforcement Configs Bucket Encryption Customer Supplied Encryption Enforcement Config - If omitted, then new objects with CSEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- Default
Kms stringKey Name - A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. You must pay attention to whether the crypto key is available in the location that this bucket is created in. See the docs for more details.
- Google
Managed []GetEncryption Enforcement Configs Bucket Encryption Google Managed Encryption Enforcement Config - If omitted, then new objects with GMEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- customer_
managed_ list(object)encryption_ enforcement_ configs - If omitted, then new objects with CMEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- customer_
supplied_ list(object)encryption_ enforcement_ configs - If omitted, then new objects with CSEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- default_
kms_ stringkey_ name - A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. You must pay attention to whether the crypto key is available in the location that this bucket is created in. See the docs for more details.
- google_
managed_ list(object)encryption_ enforcement_ configs - If omitted, then new objects with GMEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- customer
Managed List<GetEncryption Enforcement Configs Bucket Encryption Customer Managed Encryption Enforcement Config> - If omitted, then new objects with CMEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- customer
Supplied List<GetEncryption Enforcement Configs Bucket Encryption Customer Supplied Encryption Enforcement Config> - If omitted, then new objects with CSEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- default
Kms StringKey Name - A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. You must pay attention to whether the crypto key is available in the location that this bucket is created in. See the docs for more details.
- google
Managed List<GetEncryption Enforcement Configs Bucket Encryption Google Managed Encryption Enforcement Config> - If omitted, then new objects with GMEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- customer
Managed GetEncryption Enforcement Configs Bucket Encryption Customer Managed Encryption Enforcement Config[] - If omitted, then new objects with CMEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- customer
Supplied GetEncryption Enforcement Configs Bucket Encryption Customer Supplied Encryption Enforcement Config[] - If omitted, then new objects with CSEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- default
Kms stringKey Name - A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. You must pay attention to whether the crypto key is available in the location that this bucket is created in. See the docs for more details.
- google
Managed GetEncryption Enforcement Configs Bucket Encryption Google Managed Encryption Enforcement Config[] - If omitted, then new objects with GMEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- customer_
managed_ Sequence[Getencryption_ enforcement_ configs Bucket Encryption Customer Managed Encryption Enforcement Config] - If omitted, then new objects with CMEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- customer_
supplied_ Sequence[Getencryption_ enforcement_ configs Bucket Encryption Customer Supplied Encryption Enforcement Config] - If omitted, then new objects with CSEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- default_
kms_ strkey_ name - A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. You must pay attention to whether the crypto key is available in the location that this bucket is created in. See the docs for more details.
- google_
managed_ Sequence[Getencryption_ enforcement_ configs Bucket Encryption Google Managed Encryption Enforcement Config] - If omitted, then new objects with GMEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- customer
Managed List<Property Map>Encryption Enforcement Configs - If omitted, then new objects with CMEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- customer
Supplied List<Property Map>Encryption Enforcement Configs - If omitted, then new objects with CSEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
- default
Kms StringKey Name - A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. You must pay attention to whether the crypto key is available in the location that this bucket is created in. See the docs for more details.
- google
Managed List<Property Map>Encryption Enforcement Configs - If omitted, then new objects with GMEK encryption-type is allowed. If FullyRestricted, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.
GetBucketEncryptionCustomerManagedEncryptionEnforcementConfig
- Effective
Time string - Time from which the config was effective. This is service-provided.
- Restriction
Mode string - Whether CMEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using CMEK encryption. If NotRestricted or unset, creation of new objects with CMEK encryption is allowed.
- Effective
Time string - Time from which the config was effective. This is service-provided.
- Restriction
Mode string - Whether CMEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using CMEK encryption. If NotRestricted or unset, creation of new objects with CMEK encryption is allowed.
- effective_
time string - Time from which the config was effective. This is service-provided.
- restriction_
mode string - Whether CMEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using CMEK encryption. If NotRestricted or unset, creation of new objects with CMEK encryption is allowed.
- effective
Time String - Time from which the config was effective. This is service-provided.
- restriction
Mode String - Whether CMEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using CMEK encryption. If NotRestricted or unset, creation of new objects with CMEK encryption is allowed.
- effective
Time string - Time from which the config was effective. This is service-provided.
- restriction
Mode string - Whether CMEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using CMEK encryption. If NotRestricted or unset, creation of new objects with CMEK encryption is allowed.
- effective_
time str - Time from which the config was effective. This is service-provided.
- restriction_
mode str - Whether CMEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using CMEK encryption. If NotRestricted or unset, creation of new objects with CMEK encryption is allowed.
- effective
Time String - Time from which the config was effective. This is service-provided.
- restriction
Mode String - Whether CMEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using CMEK encryption. If NotRestricted or unset, creation of new objects with CMEK encryption is allowed.
GetBucketEncryptionCustomerSuppliedEncryptionEnforcementConfig
- Effective
Time string - Time from which the config was effective. This is service-provided.
- Restriction
Mode string - Whether CSEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using CSEK encryption. If NotRestricted or unset, creation of new objects with CSEK encryption is allowed.
- Effective
Time string - Time from which the config was effective. This is service-provided.
- Restriction
Mode string - Whether CSEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using CSEK encryption. If NotRestricted or unset, creation of new objects with CSEK encryption is allowed.
- effective_
time string - Time from which the config was effective. This is service-provided.
- restriction_
mode string - Whether CSEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using CSEK encryption. If NotRestricted or unset, creation of new objects with CSEK encryption is allowed.
- effective
Time String - Time from which the config was effective. This is service-provided.
- restriction
Mode String - Whether CSEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using CSEK encryption. If NotRestricted or unset, creation of new objects with CSEK encryption is allowed.
- effective
Time string - Time from which the config was effective. This is service-provided.
- restriction
Mode string - Whether CSEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using CSEK encryption. If NotRestricted or unset, creation of new objects with CSEK encryption is allowed.
- effective_
time str - Time from which the config was effective. This is service-provided.
- restriction_
mode str - Whether CSEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using CSEK encryption. If NotRestricted or unset, creation of new objects with CSEK encryption is allowed.
- effective
Time String - Time from which the config was effective. This is service-provided.
- restriction
Mode String - Whether CSEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using CSEK encryption. If NotRestricted or unset, creation of new objects with CSEK encryption is allowed.
GetBucketEncryptionGoogleManagedEncryptionEnforcementConfig
- Effective
Time string - Time from which the config was effective. This is service-provided.
- Restriction
Mode string - Whether GMEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using GMEK encryption. If NotRestricted or unset, creation of new objects with GMEK encryption is allowed.
- Effective
Time string - Time from which the config was effective. This is service-provided.
- Restriction
Mode string - Whether GMEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using GMEK encryption. If NotRestricted or unset, creation of new objects with GMEK encryption is allowed.
- effective_
time string - Time from which the config was effective. This is service-provided.
- restriction_
mode string - Whether GMEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using GMEK encryption. If NotRestricted or unset, creation of new objects with GMEK encryption is allowed.
- effective
Time String - Time from which the config was effective. This is service-provided.
- restriction
Mode String - Whether GMEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using GMEK encryption. If NotRestricted or unset, creation of new objects with GMEK encryption is allowed.
- effective
Time string - Time from which the config was effective. This is service-provided.
- restriction
Mode string - Whether GMEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using GMEK encryption. If NotRestricted or unset, creation of new objects with GMEK encryption is allowed.
- effective_
time str - Time from which the config was effective. This is service-provided.
- restriction_
mode str - Whether GMEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using GMEK encryption. If NotRestricted or unset, creation of new objects with GMEK encryption is allowed.
- effective
Time String - Time from which the config was effective. This is service-provided.
- restriction
Mode String - Whether GMEK is restricted for new objects within the bucket. If FullyRestricted, new objects can't be created using GMEK encryption. If NotRestricted or unset, creation of new objects with GMEK encryption is allowed.
GetBucketHierarchicalNamespace
- Enabled bool
- Set this field true to organize bucket with logical file system structure.
- Enabled bool
- Set this field true to organize bucket with logical file system structure.
- enabled bool
- Set this field true to organize bucket with logical file system structure.
- enabled Boolean
- Set this field true to organize bucket with logical file system structure.
- enabled boolean
- Set this field true to organize bucket with logical file system structure.
- enabled bool
- Set this field true to organize bucket with logical file system structure.
- enabled Boolean
- Set this field true to organize bucket with logical file system structure.
GetBucketIpFilter
- Allow
All boolService Agent Access - Whether to allow all service agents to access the bucket regardless of the IP filter configuration.
- Allow
Cross boolOrg Vpcs - Whether to allow cross-org VPCs in the bucket's IP filter configuration.
- Mode string
- The mode of the IP filter. Valid values are 'Enabled' and 'Disabled'.
- Public
Network List<GetSources Bucket Ip Filter Public Network Source> - The public network IP address ranges that can access the bucket and its data.
- Vpc
Network List<GetSources Bucket Ip Filter Vpc Network Source> - The list of VPC networks that can access the bucket.
- Allow
All boolService Agent Access - Whether to allow all service agents to access the bucket regardless of the IP filter configuration.
- Allow
Cross boolOrg Vpcs - Whether to allow cross-org VPCs in the bucket's IP filter configuration.
- Mode string
- The mode of the IP filter. Valid values are 'Enabled' and 'Disabled'.
- Public
Network []GetSources Bucket Ip Filter Public Network Source - The public network IP address ranges that can access the bucket and its data.
- Vpc
Network []GetSources Bucket Ip Filter Vpc Network Source - The list of VPC networks that can access the bucket.
- allow_
all_ boolservice_ agent_ access - Whether to allow all service agents to access the bucket regardless of the IP filter configuration.
- allow_
cross_ boolorg_ vpcs - Whether to allow cross-org VPCs in the bucket's IP filter configuration.
- mode string
- The mode of the IP filter. Valid values are 'Enabled' and 'Disabled'.
- public_
network_ list(object)sources - The public network IP address ranges that can access the bucket and its data.
- vpc_
network_ list(object)sources - The list of VPC networks that can access the bucket.
- allow
All BooleanService Agent Access - Whether to allow all service agents to access the bucket regardless of the IP filter configuration.
- allow
Cross BooleanOrg Vpcs - Whether to allow cross-org VPCs in the bucket's IP filter configuration.
- mode String
- The mode of the IP filter. Valid values are 'Enabled' and 'Disabled'.
- public
Network List<GetSources Bucket Ip Filter Public Network Source> - The public network IP address ranges that can access the bucket and its data.
- vpc
Network List<GetSources Bucket Ip Filter Vpc Network Source> - The list of VPC networks that can access the bucket.
- allow
All booleanService Agent Access - Whether to allow all service agents to access the bucket regardless of the IP filter configuration.
- allow
Cross booleanOrg Vpcs - Whether to allow cross-org VPCs in the bucket's IP filter configuration.
- mode string
- The mode of the IP filter. Valid values are 'Enabled' and 'Disabled'.
- public
Network GetSources Bucket Ip Filter Public Network Source[] - The public network IP address ranges that can access the bucket and its data.
- vpc
Network GetSources Bucket Ip Filter Vpc Network Source[] - The list of VPC networks that can access the bucket.
- allow_
all_ boolservice_ agent_ access - Whether to allow all service agents to access the bucket regardless of the IP filter configuration.
- allow_
cross_ boolorg_ vpcs - Whether to allow cross-org VPCs in the bucket's IP filter configuration.
- mode str
- The mode of the IP filter. Valid values are 'Enabled' and 'Disabled'.
- public_
network_ Sequence[Getsources Bucket Ip Filter Public Network Source] - The public network IP address ranges that can access the bucket and its data.
- vpc_
network_ Sequence[Getsources Bucket Ip Filter Vpc Network Source] - The list of VPC networks that can access the bucket.
- allow
All BooleanService Agent Access - Whether to allow all service agents to access the bucket regardless of the IP filter configuration.
- allow
Cross BooleanOrg Vpcs - Whether to allow cross-org VPCs in the bucket's IP filter configuration.
- mode String
- The mode of the IP filter. Valid values are 'Enabled' and 'Disabled'.
- public
Network List<Property Map>Sources - The public network IP address ranges that can access the bucket and its data.
- vpc
Network List<Property Map>Sources - The list of VPC networks that can access the bucket.
GetBucketIpFilterPublicNetworkSource
- Allowed
Ip List<string>Cidr Ranges - The list of public IPv4, IPv6 cidr ranges that are allowed to access the bucket.
- Allowed
Ip []stringCidr Ranges - The list of public IPv4, IPv6 cidr ranges that are allowed to access the bucket.
- allowed_
ip_ list(string)cidr_ ranges - The list of public IPv4, IPv6 cidr ranges that are allowed to access the bucket.
- allowed
Ip List<String>Cidr Ranges - The list of public IPv4, IPv6 cidr ranges that are allowed to access the bucket.
- allowed
Ip string[]Cidr Ranges - The list of public IPv4, IPv6 cidr ranges that are allowed to access the bucket.
- allowed_
ip_ Sequence[str]cidr_ ranges - The list of public IPv4, IPv6 cidr ranges that are allowed to access the bucket.
- allowed
Ip List<String>Cidr Ranges - The list of public IPv4, IPv6 cidr ranges that are allowed to access the bucket.
GetBucketIpFilterVpcNetworkSource
- Allowed
Ip List<string>Cidr Ranges - The list of public or private IPv4 and IPv6 CIDR ranges that can access the bucket.
- Network string
- Name of the network. Format: projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}
- Allowed
Ip []stringCidr Ranges - The list of public or private IPv4 and IPv6 CIDR ranges that can access the bucket.
- Network string
- Name of the network. Format: projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}
- allowed_
ip_ list(string)cidr_ ranges - The list of public or private IPv4 and IPv6 CIDR ranges that can access the bucket.
- network string
- Name of the network. Format: projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}
- allowed
Ip List<String>Cidr Ranges - The list of public or private IPv4 and IPv6 CIDR ranges that can access the bucket.
- network String
- Name of the network. Format: projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}
- allowed
Ip string[]Cidr Ranges - The list of public or private IPv4 and IPv6 CIDR ranges that can access the bucket.
- network string
- Name of the network. Format: projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}
- allowed_
ip_ Sequence[str]cidr_ ranges - The list of public or private IPv4 and IPv6 CIDR ranges that can access the bucket.
- network str
- Name of the network. Format: projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}
- allowed
Ip List<String>Cidr Ranges - The list of public or private IPv4 and IPv6 CIDR ranges that can access the bucket.
- network String
- Name of the network. Format: projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}
GetBucketLifecycleRule
- Actions
List<Get
Bucket Lifecycle Rule Action> - The Lifecycle Rule's action configuration. A single block of this type is supported.
- Conditions
List<Get
Bucket Lifecycle Rule Condition> - The Lifecycle Rule's condition configuration.
- Actions
[]Get
Bucket Lifecycle Rule Action - The Lifecycle Rule's action configuration. A single block of this type is supported.
- Conditions
[]Get
Bucket Lifecycle Rule Condition - The Lifecycle Rule's condition configuration.
- actions list(object)
- The Lifecycle Rule's action configuration. A single block of this type is supported.
- conditions list(object)
- The Lifecycle Rule's condition configuration.
- actions
List<Get
Bucket Lifecycle Rule Action> - The Lifecycle Rule's action configuration. A single block of this type is supported.
- conditions
List<Get
Bucket Lifecycle Rule Condition> - The Lifecycle Rule's condition configuration.
- actions
Get
Bucket Lifecycle Rule Action[] - The Lifecycle Rule's action configuration. A single block of this type is supported.
- conditions
Get
Bucket Lifecycle Rule Condition[] - The Lifecycle Rule's condition configuration.
- actions
Sequence[Get
Bucket Lifecycle Rule Action] - The Lifecycle Rule's action configuration. A single block of this type is supported.
- conditions
Sequence[Get
Bucket Lifecycle Rule Condition] - The Lifecycle Rule's condition configuration.
- actions List<Property Map>
- The Lifecycle Rule's action configuration. A single block of this type is supported.
- conditions List<Property Map>
- The Lifecycle Rule's condition configuration.
GetBucketLifecycleRuleAction
- Storage
Class string - The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE.
- Type string
- The type of the action of this Lifecycle Rule. Supported values include: Delete, SetStorageClass and AbortIncompleteMultipartUpload.
- Storage
Class string - The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE.
- Type string
- The type of the action of this Lifecycle Rule. Supported values include: Delete, SetStorageClass and AbortIncompleteMultipartUpload.
- storage_
class string - The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE.
- type string
- The type of the action of this Lifecycle Rule. Supported values include: Delete, SetStorageClass and AbortIncompleteMultipartUpload.
- storage
Class String - The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE.
- type String
- The type of the action of this Lifecycle Rule. Supported values include: Delete, SetStorageClass and AbortIncompleteMultipartUpload.
- storage
Class string - The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE.
- type string
- The type of the action of this Lifecycle Rule. Supported values include: Delete, SetStorageClass and AbortIncompleteMultipartUpload.
- storage_
class str - The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE.
- type str
- The type of the action of this Lifecycle Rule. Supported values include: Delete, SetStorageClass and AbortIncompleteMultipartUpload.
- storage
Class String - The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE.
- type String
- The type of the action of this Lifecycle Rule. Supported values include: Delete, SetStorageClass and AbortIncompleteMultipartUpload.
GetBucketLifecycleRuleCondition
- Age int
- Minimum age of an object in days to satisfy this condition.
- Created
Before string - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- Custom
Time stringBefore - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- Days
Since intCustom Time - Number of days elapsed since the user-specified timestamp set on an object.
- Days
Since intNoncurrent Time - Number of days elapsed since the noncurrent timestamp of an object. This condition is relevant only for versioned objects.
- Matches
Prefixes List<string> - One or more matching name prefixes to satisfy this condition.
- Matches
Storage List<string>Classes - Storage Class of objects to satisfy this condition. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, DURABLE_REDUCED_AVAILABILITY.
- Matches
Suffixes List<string> - One or more matching name suffixes to satisfy this condition.
- Noncurrent
Time stringBefore - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- Num
Newer intVersions - Relevant only for versioned objects. The number of newer versions of an object to satisfy this condition.
- Send
Age boolIf Zero - While set true, age value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the age field. It can be used alone or together with age.
- Send
Days boolSince Custom Time If Zero - While set true, daysSinceCustomTime value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the daysSinceCustomTime field. It can be used alone or together with days_since_custom_time.
- Send
Days boolSince Noncurrent Time If Zero - While set true, daysSinceNoncurrentTime value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the daysSinceNoncurrentTime field. It can be used alone or together with days_since_noncurrent_time.
- Send
Num boolNewer Versions If Zero - While set true, numNewerVersions value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the numNewerVersions field. It can be used alone or together with num_newer_versions.
- With
State string - Match to live and/or archived objects. Unversioned buckets have only live objects. Supported values include: "LIVE", "ARCHIVED", "ANY".
- Age int
- Minimum age of an object in days to satisfy this condition.
- Created
Before string - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- Custom
Time stringBefore - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- Days
Since intCustom Time - Number of days elapsed since the user-specified timestamp set on an object.
- Days
Since intNoncurrent Time - Number of days elapsed since the noncurrent timestamp of an object. This condition is relevant only for versioned objects.
- Matches
Prefixes []string - One or more matching name prefixes to satisfy this condition.
- Matches
Storage []stringClasses - Storage Class of objects to satisfy this condition. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, DURABLE_REDUCED_AVAILABILITY.
- Matches
Suffixes []string - One or more matching name suffixes to satisfy this condition.
- Noncurrent
Time stringBefore - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- Num
Newer intVersions - Relevant only for versioned objects. The number of newer versions of an object to satisfy this condition.
- Send
Age boolIf Zero - While set true, age value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the age field. It can be used alone or together with age.
- Send
Days boolSince Custom Time If Zero - While set true, daysSinceCustomTime value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the daysSinceCustomTime field. It can be used alone or together with days_since_custom_time.
- Send
Days boolSince Noncurrent Time If Zero - While set true, daysSinceNoncurrentTime value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the daysSinceNoncurrentTime field. It can be used alone or together with days_since_noncurrent_time.
- Send
Num boolNewer Versions If Zero - While set true, numNewerVersions value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the numNewerVersions field. It can be used alone or together with num_newer_versions.
- With
State string - Match to live and/or archived objects. Unversioned buckets have only live objects. Supported values include: "LIVE", "ARCHIVED", "ANY".
- age number
- Minimum age of an object in days to satisfy this condition.
- created_
before string - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- custom_
time_ stringbefore - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- days_
since_ numbercustom_ time - Number of days elapsed since the user-specified timestamp set on an object.
- days_
since_ numbernoncurrent_ time - Number of days elapsed since the noncurrent timestamp of an object. This condition is relevant only for versioned objects.
- matches_
prefixes list(string) - One or more matching name prefixes to satisfy this condition.
- matches_
storage_ list(string)classes - Storage Class of objects to satisfy this condition. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, DURABLE_REDUCED_AVAILABILITY.
- matches_
suffixes list(string) - One or more matching name suffixes to satisfy this condition.
- noncurrent_
time_ stringbefore - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- num_
newer_ numberversions - Relevant only for versioned objects. The number of newer versions of an object to satisfy this condition.
- send_
age_ boolif_ zero - While set true, age value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the age field. It can be used alone or together with age.
- send_
days_ boolsince_ custom_ time_ if_ zero - While set true, daysSinceCustomTime value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the daysSinceCustomTime field. It can be used alone or together with days_since_custom_time.
- send_
days_ boolsince_ noncurrent_ time_ if_ zero - While set true, daysSinceNoncurrentTime value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the daysSinceNoncurrentTime field. It can be used alone or together with days_since_noncurrent_time.
- send_
num_ boolnewer_ versions_ if_ zero - While set true, numNewerVersions value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the numNewerVersions field. It can be used alone or together with num_newer_versions.
- with_
state string - Match to live and/or archived objects. Unversioned buckets have only live objects. Supported values include: "LIVE", "ARCHIVED", "ANY".
- age Integer
- Minimum age of an object in days to satisfy this condition.
- created
Before String - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- custom
Time StringBefore - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- days
Since IntegerCustom Time - Number of days elapsed since the user-specified timestamp set on an object.
- days
Since IntegerNoncurrent Time - Number of days elapsed since the noncurrent timestamp of an object. This condition is relevant only for versioned objects.
- matches
Prefixes List<String> - One or more matching name prefixes to satisfy this condition.
- matches
Storage List<String>Classes - Storage Class of objects to satisfy this condition. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, DURABLE_REDUCED_AVAILABILITY.
- matches
Suffixes List<String> - One or more matching name suffixes to satisfy this condition.
- noncurrent
Time StringBefore - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- num
Newer IntegerVersions - Relevant only for versioned objects. The number of newer versions of an object to satisfy this condition.
- send
Age BooleanIf Zero - While set true, age value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the age field. It can be used alone or together with age.
- send
Days BooleanSince Custom Time If Zero - While set true, daysSinceCustomTime value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the daysSinceCustomTime field. It can be used alone or together with days_since_custom_time.
- send
Days BooleanSince Noncurrent Time If Zero - While set true, daysSinceNoncurrentTime value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the daysSinceNoncurrentTime field. It can be used alone or together with days_since_noncurrent_time.
- send
Num BooleanNewer Versions If Zero - While set true, numNewerVersions value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the numNewerVersions field. It can be used alone or together with num_newer_versions.
- with
State String - Match to live and/or archived objects. Unversioned buckets have only live objects. Supported values include: "LIVE", "ARCHIVED", "ANY".
- age number
- Minimum age of an object in days to satisfy this condition.
- created
Before string - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- custom
Time stringBefore - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- days
Since numberCustom Time - Number of days elapsed since the user-specified timestamp set on an object.
- days
Since numberNoncurrent Time - Number of days elapsed since the noncurrent timestamp of an object. This condition is relevant only for versioned objects.
- matches
Prefixes string[] - One or more matching name prefixes to satisfy this condition.
- matches
Storage string[]Classes - Storage Class of objects to satisfy this condition. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, DURABLE_REDUCED_AVAILABILITY.
- matches
Suffixes string[] - One or more matching name suffixes to satisfy this condition.
- noncurrent
Time stringBefore - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- num
Newer numberVersions - Relevant only for versioned objects. The number of newer versions of an object to satisfy this condition.
- send
Age booleanIf Zero - While set true, age value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the age field. It can be used alone or together with age.
- send
Days booleanSince Custom Time If Zero - While set true, daysSinceCustomTime value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the daysSinceCustomTime field. It can be used alone or together with days_since_custom_time.
- send
Days booleanSince Noncurrent Time If Zero - While set true, daysSinceNoncurrentTime value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the daysSinceNoncurrentTime field. It can be used alone or together with days_since_noncurrent_time.
- send
Num booleanNewer Versions If Zero - While set true, numNewerVersions value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the numNewerVersions field. It can be used alone or together with num_newer_versions.
- with
State string - Match to live and/or archived objects. Unversioned buckets have only live objects. Supported values include: "LIVE", "ARCHIVED", "ANY".
- age int
- Minimum age of an object in days to satisfy this condition.
- created_
before str - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- custom_
time_ strbefore - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- days_
since_ intcustom_ time - Number of days elapsed since the user-specified timestamp set on an object.
- days_
since_ intnoncurrent_ time - Number of days elapsed since the noncurrent timestamp of an object. This condition is relevant only for versioned objects.
- matches_
prefixes Sequence[str] - One or more matching name prefixes to satisfy this condition.
- matches_
storage_ Sequence[str]classes - Storage Class of objects to satisfy this condition. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, DURABLE_REDUCED_AVAILABILITY.
- matches_
suffixes Sequence[str] - One or more matching name suffixes to satisfy this condition.
- noncurrent_
time_ strbefore - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- num_
newer_ intversions - Relevant only for versioned objects. The number of newer versions of an object to satisfy this condition.
- send_
age_ boolif_ zero - While set true, age value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the age field. It can be used alone or together with age.
- send_
days_ boolsince_ custom_ time_ if_ zero - While set true, daysSinceCustomTime value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the daysSinceCustomTime field. It can be used alone or together with days_since_custom_time.
- send_
days_ boolsince_ noncurrent_ time_ if_ zero - While set true, daysSinceNoncurrentTime value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the daysSinceNoncurrentTime field. It can be used alone or together with days_since_noncurrent_time.
- send_
num_ boolnewer_ versions_ if_ zero - While set true, numNewerVersions value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the numNewerVersions field. It can be used alone or together with num_newer_versions.
- with_
state str - Match to live and/or archived objects. Unversioned buckets have only live objects. Supported values include: "LIVE", "ARCHIVED", "ANY".
- age Number
- Minimum age of an object in days to satisfy this condition.
- created
Before String - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- custom
Time StringBefore - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- days
Since NumberCustom Time - Number of days elapsed since the user-specified timestamp set on an object.
- days
Since NumberNoncurrent Time - Number of days elapsed since the noncurrent timestamp of an object. This condition is relevant only for versioned objects.
- matches
Prefixes List<String> - One or more matching name prefixes to satisfy this condition.
- matches
Storage List<String>Classes - Storage Class of objects to satisfy this condition. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, DURABLE_REDUCED_AVAILABILITY.
- matches
Suffixes List<String> - One or more matching name suffixes to satisfy this condition.
- noncurrent
Time StringBefore - Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
- num
Newer NumberVersions - Relevant only for versioned objects. The number of newer versions of an object to satisfy this condition.
- send
Age BooleanIf Zero - While set true, age value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the age field. It can be used alone or together with age.
- send
Days BooleanSince Custom Time If Zero - While set true, daysSinceCustomTime value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the daysSinceCustomTime field. It can be used alone or together with days_since_custom_time.
- send
Days BooleanSince Noncurrent Time If Zero - While set true, daysSinceNoncurrentTime value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the daysSinceNoncurrentTime field. It can be used alone or together with days_since_noncurrent_time.
- send
Num BooleanNewer Versions If Zero - While set true, numNewerVersions value will be sent in the request even for zero value of the field. This field is only useful for setting 0 value to the numNewerVersions field. It can be used alone or together with num_newer_versions.
- with
State String - Match to live and/or archived objects. Unversioned buckets have only live objects. Supported values include: "LIVE", "ARCHIVED", "ANY".
GetBucketLogging
- Log
Bucket string - The bucket that will receive log objects.
- Log
Object stringPrefix - The object prefix for log objects. If it's not provided, by default Google Cloud Storage sets this to this bucket's name.
- Log
Bucket string - The bucket that will receive log objects.
- Log
Object stringPrefix - The object prefix for log objects. If it's not provided, by default Google Cloud Storage sets this to this bucket's name.
- log_
bucket string - The bucket that will receive log objects.
- log_
object_ stringprefix - The object prefix for log objects. If it's not provided, by default Google Cloud Storage sets this to this bucket's name.
- log
Bucket String - The bucket that will receive log objects.
- log
Object StringPrefix - The object prefix for log objects. If it's not provided, by default Google Cloud Storage sets this to this bucket's name.
- log
Bucket string - The bucket that will receive log objects.
- log
Object stringPrefix - The object prefix for log objects. If it's not provided, by default Google Cloud Storage sets this to this bucket's name.
- log_
bucket str - The bucket that will receive log objects.
- log_
object_ strprefix - The object prefix for log objects. If it's not provided, by default Google Cloud Storage sets this to this bucket's name.
- log
Bucket String - The bucket that will receive log objects.
- log
Object StringPrefix - The object prefix for log objects. If it's not provided, by default Google Cloud Storage sets this to this bucket's name.
GetBucketRetentionPolicy
- Is
Locked bool - If set to true, the bucket will be locked and permanently restrict edits to the bucket's retention policy. Caution: Locking a bucket is an irreversible action.
- Retention
Period string - The period of time, in seconds, that objects in the bucket must be retained and cannot be deleted, overwritten, or archived. The value must be less than 3,155,760,000 seconds.
- Is
Locked bool - If set to true, the bucket will be locked and permanently restrict edits to the bucket's retention policy. Caution: Locking a bucket is an irreversible action.
- Retention
Period string - The period of time, in seconds, that objects in the bucket must be retained and cannot be deleted, overwritten, or archived. The value must be less than 3,155,760,000 seconds.
- is_
locked bool - If set to true, the bucket will be locked and permanently restrict edits to the bucket's retention policy. Caution: Locking a bucket is an irreversible action.
- retention_
period string - The period of time, in seconds, that objects in the bucket must be retained and cannot be deleted, overwritten, or archived. The value must be less than 3,155,760,000 seconds.
- is
Locked Boolean - If set to true, the bucket will be locked and permanently restrict edits to the bucket's retention policy. Caution: Locking a bucket is an irreversible action.
- retention
Period String - The period of time, in seconds, that objects in the bucket must be retained and cannot be deleted, overwritten, or archived. The value must be less than 3,155,760,000 seconds.
- is
Locked boolean - If set to true, the bucket will be locked and permanently restrict edits to the bucket's retention policy. Caution: Locking a bucket is an irreversible action.
- retention
Period string - The period of time, in seconds, that objects in the bucket must be retained and cannot be deleted, overwritten, or archived. The value must be less than 3,155,760,000 seconds.
- is_
locked bool - If set to true, the bucket will be locked and permanently restrict edits to the bucket's retention policy. Caution: Locking a bucket is an irreversible action.
- retention_
period str - The period of time, in seconds, that objects in the bucket must be retained and cannot be deleted, overwritten, or archived. The value must be less than 3,155,760,000 seconds.
- is
Locked Boolean - If set to true, the bucket will be locked and permanently restrict edits to the bucket's retention policy. Caution: Locking a bucket is an irreversible action.
- retention
Period String - The period of time, in seconds, that objects in the bucket must be retained and cannot be deleted, overwritten, or archived. The value must be less than 3,155,760,000 seconds.
GetBucketSoftDeletePolicy
- Effective
Time string - Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format.
- Retention
Duration intSeconds - The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. Default value is 604800.
- Effective
Time string - Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format.
- Retention
Duration intSeconds - The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. Default value is 604800.
- effective_
time string - Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format.
- retention_
duration_ numberseconds - The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. Default value is 604800.
- effective
Time String - Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format.
- retention
Duration IntegerSeconds - The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. Default value is 604800.
- effective
Time string - Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format.
- retention
Duration numberSeconds - The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. Default value is 604800.
- effective_
time str - Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format.
- retention_
duration_ intseconds - The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. Default value is 604800.
- effective
Time String - Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format.
- retention
Duration NumberSeconds - The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. Default value is 604800.
GetBucketVersioning
- Enabled bool
- While set to true, versioning is fully enabled for this bucket.
- Enabled bool
- While set to true, versioning is fully enabled for this bucket.
- enabled bool
- While set to true, versioning is fully enabled for this bucket.
- enabled Boolean
- While set to true, versioning is fully enabled for this bucket.
- enabled boolean
- While set to true, versioning is fully enabled for this bucket.
- enabled bool
- While set to true, versioning is fully enabled for this bucket.
- enabled Boolean
- While set to true, versioning is fully enabled for this bucket.
GetBucketWebsite
- Main
Page stringSuffix - Behaves as the bucket's directory index where missing objects are treated as potential directories.
- Not
Found stringPage - The custom object to return when a requested resource is not found.
- Main
Page stringSuffix - Behaves as the bucket's directory index where missing objects are treated as potential directories.
- Not
Found stringPage - The custom object to return when a requested resource is not found.
- main_
page_ stringsuffix - Behaves as the bucket's directory index where missing objects are treated as potential directories.
- not_
found_ stringpage - The custom object to return when a requested resource is not found.
- main
Page StringSuffix - Behaves as the bucket's directory index where missing objects are treated as potential directories.
- not
Found StringPage - The custom object to return when a requested resource is not found.
- main
Page stringSuffix - Behaves as the bucket's directory index where missing objects are treated as potential directories.
- not
Found stringPage - The custom object to return when a requested resource is not found.
- main_
page_ strsuffix - Behaves as the bucket's directory index where missing objects are treated as potential directories.
- not_
found_ strpage - The custom object to return when a requested resource is not found.
- main
Page StringSuffix - Behaves as the bucket's directory index where missing objects are treated as potential directories.
- not
Found StringPage - The custom object to return when a requested resource is not found.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.
Viewing docs for Google Cloud v9.23.0
published on Thursday, May 7, 2026 by Pulumi
published on Thursday, May 7, 2026 by Pulumi
