Google Cloud Native v0.31.1, Jul 20 23

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.storage/v1.getBucket

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

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(bucket: Optional[str] = None,
               if_metageneration_match: Optional[str] = None,
               if_metageneration_not_match: Optional[str] = None,
               projection: Optional[str] = None,
               user_project: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetBucketResult
def get_bucket_output(bucket: Optional[pulumi.Input[str]] = None,
               if_metageneration_match: Optional[pulumi.Input[str]] = None,
               if_metageneration_not_match: Optional[pulumi.Input[str]] = None,
               projection: Optional[pulumi.Input[str]] = None,
               user_project: Optional[pulumi.Input[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)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:storage/v1:getBucket
  arguments:
    # arguments dictionary

The following arguments are supported:

Bucket string
IfMetagenerationMatch string
IfMetagenerationNotMatch string
Projection string
UserProject string

Bucket string
IfMetagenerationMatch string
IfMetagenerationNotMatch string
Projection string
UserProject string

bucket String
ifMetagenerationMatch String
ifMetagenerationNotMatch String
projection String
userProject String

bucket string
ifMetagenerationMatch string
ifMetagenerationNotMatch string
projection string
userProject string

bucket str
if_metageneration_match str
if_metageneration_not_match str
projection str
user_project str

bucket String
ifMetagenerationMatch String
ifMetagenerationNotMatch String
projection String
userProject String

getBucket Result

The following output properties are available:

Acl List<Pulumi.GoogleNative.Storage.V1.Outputs.BucketAccessControlResponse>: Access controls on the bucket.
Autoclass Pulumi.GoogleNative.Storage.V1.Outputs.BucketAutoclassResponse: The bucket's Autoclass configuration.
Billing Pulumi.GoogleNative.Storage.V1.Outputs.BucketBillingResponse: The bucket's billing configuration.
Cors List<Pulumi.GoogleNative.Storage.V1.Outputs.BucketCorsItemResponse>: The bucket's Cross-Origin Resource Sharing (CORS) configuration.
CustomPlacementConfig Pulumi.GoogleNative.Storage.V1.Outputs.BucketCustomPlacementConfigResponse: The bucket's custom placement configuration for Custom Dual Regions.
DefaultEventBasedHold bool: The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
DefaultObjectAcl List<Pulumi.GoogleNative.Storage.V1.Outputs.ObjectAccessControlResponse>: Default access controls to apply to new objects when no ACL is provided.
Encryption Pulumi.GoogleNative.Storage.V1.Outputs.BucketEncryptionResponse: Encryption configuration for a bucket.
Etag string: HTTP 1.1 Entity tag for the bucket.
IamConfiguration Pulumi.GoogleNative.Storage.V1.Outputs.BucketIamConfigurationResponse: The bucket's IAM configuration.
Kind string: The kind of item this is. For buckets, this is always storage#bucket.
Labels Dictionary<string, string>: User-provided labels, in key/value pairs.
Lifecycle Pulumi.GoogleNative.Storage.V1.Outputs.BucketLifecycleResponse: The bucket's lifecycle configuration. See lifecycle management for more information.
Location string: The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.
LocationType string: The type of the bucket location.
Logging Pulumi.GoogleNative.Storage.V1.Outputs.BucketLoggingResponse: The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
Metageneration string: The metadata generation of this bucket.
Name string: The name of the bucket.
Owner Pulumi.GoogleNative.Storage.V1.Outputs.BucketOwnerResponse: The owner of the bucket. This is always the project team's owner group.
ProjectNumber string: The project number of the project the bucket belongs to.
RetentionPolicy Pulumi.GoogleNative.Storage.V1.Outputs.BucketRetentionPolicyResponse: The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
Rpo string: The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
SatisfiesPZS bool: Reserved for future use.
SelfLink string: The URI of this bucket.
StorageClass string: The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
TimeCreated string: The creation time of the bucket in RFC 3339 format.
Updated string: The modification time of the bucket in RFC 3339 format.
Versioning Pulumi.GoogleNative.Storage.V1.Outputs.BucketVersioningResponse: The bucket's versioning configuration.
Website Pulumi.GoogleNative.Storage.V1.Outputs.BucketWebsiteResponse: The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.

Acl []BucketAccessControlResponse: Access controls on the bucket.
Autoclass BucketAutoclassResponse: The bucket's Autoclass configuration.
Billing BucketBillingResponse: The bucket's billing configuration.
Cors []BucketCorsItemResponse: The bucket's Cross-Origin Resource Sharing (CORS) configuration.
CustomPlacementConfig BucketCustomPlacementConfigResponse: The bucket's custom placement configuration for Custom Dual Regions.
DefaultEventBasedHold bool: The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
DefaultObjectAcl []ObjectAccessControlResponse: Default access controls to apply to new objects when no ACL is provided.
Encryption BucketEncryptionResponse: Encryption configuration for a bucket.
Etag string: HTTP 1.1 Entity tag for the bucket.
IamConfiguration BucketIamConfigurationResponse: The bucket's IAM configuration.
Kind string: The kind of item this is. For buckets, this is always storage#bucket.
Labels map[string]string: User-provided labels, in key/value pairs.
Lifecycle BucketLifecycleResponse: The bucket's lifecycle configuration. See lifecycle management for more information.
Location string: The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.
LocationType string: The type of the bucket location.
Logging BucketLoggingResponse: The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
Metageneration string: The metadata generation of this bucket.
Name string: The name of the bucket.
Owner BucketOwnerResponse: The owner of the bucket. This is always the project team's owner group.
ProjectNumber string: The project number of the project the bucket belongs to.
RetentionPolicy BucketRetentionPolicyResponse: The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
Rpo string: The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
SatisfiesPZS bool: Reserved for future use.
SelfLink string: The URI of this bucket.
StorageClass string: The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
TimeCreated string: The creation time of the bucket in RFC 3339 format.
Updated string: The modification time of the bucket in RFC 3339 format.
Versioning BucketVersioningResponse: The bucket's versioning configuration.
Website BucketWebsiteResponse: The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.

acl List<BucketAccessControlResponse>: Access controls on the bucket.
autoclass BucketAutoclassResponse: The bucket's Autoclass configuration.
billing BucketBillingResponse: The bucket's billing configuration.
cors List<BucketCorsItemResponse>: The bucket's Cross-Origin Resource Sharing (CORS) configuration.
customPlacementConfig BucketCustomPlacementConfigResponse: The bucket's custom placement configuration for Custom Dual Regions.
defaultEventBasedHold Boolean: The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
defaultObjectAcl List<ObjectAccessControlResponse>: Default access controls to apply to new objects when no ACL is provided.
encryption BucketEncryptionResponse: Encryption configuration for a bucket.
etag String: HTTP 1.1 Entity tag for the bucket.
iamConfiguration BucketIamConfigurationResponse: The bucket's IAM configuration.
kind String: The kind of item this is. For buckets, this is always storage#bucket.
labels Map<String,String>: User-provided labels, in key/value pairs.
lifecycle BucketLifecycleResponse: The bucket's lifecycle configuration. See lifecycle management for more information.
location String: The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.
locationType String: The type of the bucket location.
logging BucketLoggingResponse: The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
metageneration String: The metadata generation of this bucket.
name String: The name of the bucket.
owner BucketOwnerResponse: The owner of the bucket. This is always the project team's owner group.
projectNumber String: The project number of the project the bucket belongs to.
retentionPolicy BucketRetentionPolicyResponse: The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
rpo String: The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
satisfiesPZS Boolean: Reserved for future use.
selfLink String: The URI of this bucket.
storageClass String: The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
timeCreated String: The creation time of the bucket in RFC 3339 format.
updated String: The modification time of the bucket in RFC 3339 format.
versioning BucketVersioningResponse: The bucket's versioning configuration.
website BucketWebsiteResponse: The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.

acl BucketAccessControlResponse[]: Access controls on the bucket.
autoclass BucketAutoclassResponse: The bucket's Autoclass configuration.
billing BucketBillingResponse: The bucket's billing configuration.
cors BucketCorsItemResponse[]: The bucket's Cross-Origin Resource Sharing (CORS) configuration.
customPlacementConfig BucketCustomPlacementConfigResponse: The bucket's custom placement configuration for Custom Dual Regions.
defaultEventBasedHold boolean: The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
defaultObjectAcl ObjectAccessControlResponse[]: Default access controls to apply to new objects when no ACL is provided.
encryption BucketEncryptionResponse: Encryption configuration for a bucket.
etag string: HTTP 1.1 Entity tag for the bucket.
iamConfiguration BucketIamConfigurationResponse: The bucket's IAM configuration.
kind string: The kind of item this is. For buckets, this is always storage#bucket.
labels {[key: string]: string}: User-provided labels, in key/value pairs.
lifecycle BucketLifecycleResponse: The bucket's lifecycle configuration. See lifecycle management for more information.
location string: The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.
locationType string: The type of the bucket location.
logging BucketLoggingResponse: The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
metageneration string: The metadata generation of this bucket.
name string: The name of the bucket.
owner BucketOwnerResponse: The owner of the bucket. This is always the project team's owner group.
projectNumber string: The project number of the project the bucket belongs to.
retentionPolicy BucketRetentionPolicyResponse: The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
rpo string: The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
satisfiesPZS boolean: Reserved for future use.
selfLink string: The URI of this bucket.
storageClass string: The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
timeCreated string: The creation time of the bucket in RFC 3339 format.
updated string: The modification time of the bucket in RFC 3339 format.
versioning BucketVersioningResponse: The bucket's versioning configuration.
website BucketWebsiteResponse: The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.

acl Sequence[BucketAccessControlResponse]: Access controls on the bucket.
autoclass BucketAutoclassResponse: The bucket's Autoclass configuration.
billing BucketBillingResponse: The bucket's billing configuration.
cors Sequence[BucketCorsItemResponse]: The bucket's Cross-Origin Resource Sharing (CORS) configuration.
custom_placement_config BucketCustomPlacementConfigResponse: The bucket's custom placement configuration for Custom Dual Regions.
default_event_based_hold bool: The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
default_object_acl Sequence[ObjectAccessControlResponse]: Default access controls to apply to new objects when no ACL is provided.
encryption BucketEncryptionResponse: Encryption configuration for a bucket.
etag str: HTTP 1.1 Entity tag for the bucket.
iam_configuration BucketIamConfigurationResponse: The bucket's IAM configuration.
kind str: The kind of item this is. For buckets, this is always storage#bucket.
labels Mapping[str, str]: User-provided labels, in key/value pairs.
lifecycle BucketLifecycleResponse: The bucket's lifecycle configuration. See lifecycle management for more information.
location str: The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.
location_type str: The type of the bucket location.
logging BucketLoggingResponse: The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
metageneration str: The metadata generation of this bucket.
name str: The name of the bucket.
owner BucketOwnerResponse: The owner of the bucket. This is always the project team's owner group.
project_number str: The project number of the project the bucket belongs to.
retention_policy BucketRetentionPolicyResponse: The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
rpo str: The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
satisfies_pzs bool: Reserved for future use.
self_link str: The URI of this bucket.
storage_class str: The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
time_created str: The creation time of the bucket in RFC 3339 format.
updated str: The modification time of the bucket in RFC 3339 format.
versioning BucketVersioningResponse: The bucket's versioning configuration.
website BucketWebsiteResponse: The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.

acl List<Property Map>: Access controls on the bucket.
autoclass Property Map: The bucket's Autoclass configuration.
billing Property Map: The bucket's billing configuration.
cors List<Property Map>: The bucket's Cross-Origin Resource Sharing (CORS) configuration.
customPlacementConfig Property Map: The bucket's custom placement configuration for Custom Dual Regions.
defaultEventBasedHold Boolean: The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
defaultObjectAcl List<Property Map>: Default access controls to apply to new objects when no ACL is provided.
encryption Property Map: Encryption configuration for a bucket.
etag String: HTTP 1.1 Entity tag for the bucket.
iamConfiguration Property Map: The bucket's IAM configuration.
kind String: The kind of item this is. For buckets, this is always storage#bucket.
labels Map<String>: User-provided labels, in key/value pairs.
lifecycle Property Map: The bucket's lifecycle configuration. See lifecycle management for more information.
location String: The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.
locationType String: The type of the bucket location.
logging Property Map: The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
metageneration String: The metadata generation of this bucket.
name String: The name of the bucket.
owner Property Map: The owner of the bucket. This is always the project team's owner group.
projectNumber String: The project number of the project the bucket belongs to.
retentionPolicy Property Map: The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
rpo String: The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
satisfiesPZS Boolean: Reserved for future use.
selfLink String: The URI of this bucket.
storageClass String: The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
timeCreated String: The creation time of the bucket in RFC 3339 format.
updated String: The modification time of the bucket in RFC 3339 format.
versioning Property Map: The bucket's versioning configuration.
website Property Map: The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.

Supporting Types

BucketAccessControlProjectTeamResponse

ProjectNumber string: The project number.
Team string: The team.

ProjectNumber string: The project number.
Team string: The team.

projectNumber String: The project number.
team String: The team.

projectNumber string: The project number.
team string: The team.

project_number str: The project number.
team str: The team.

projectNumber String: The project number.
team String: The team.

BucketAccessControlResponse

Bucket string

The name of the bucket.

Domain string

The domain associated with the entity, if any.

Email string

The email address associated with the entity, if any.

Entity string

The entity holding the permission, in one of the following forms:

user-userId
user-email
group-groupId
group-email
domain-domain
project-team-projectId
allUsers
allAuthenticatedUsers Examples:
The user liz@example.com would be user-liz@example.com.
The group example@googlegroups.com would be group-example@googlegroups.com.
To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

EntityId string

The ID for the entity, if any.

Etag string

HTTP 1.1 Entity tag for the access-control entry.

Kind string

The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.

ProjectTeam Pulumi.GoogleNative.Storage.V1.Inputs.BucketAccessControlProjectTeamResponse

The project team associated with the entity, if any.

Role string

The access permission for the entity.

SelfLink string

The link to this access-control entry.

Bucket string

The name of the bucket.

Domain string

The domain associated with the entity, if any.

Email string

The email address associated with the entity, if any.

Entity string

The entity holding the permission, in one of the following forms:

user-userId
user-email
group-groupId
group-email
domain-domain
project-team-projectId
allUsers
allAuthenticatedUsers Examples:
The user liz@example.com would be user-liz@example.com.
The group example@googlegroups.com would be group-example@googlegroups.com.
To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

EntityId string

The ID for the entity, if any.

Etag string

HTTP 1.1 Entity tag for the access-control entry.

Kind string

The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.

ProjectTeam BucketAccessControlProjectTeamResponse

The project team associated with the entity, if any.

Role string

The access permission for the entity.

SelfLink string

The link to this access-control entry.

bucket String

The name of the bucket.

domain String

The domain associated with the entity, if any.

email String

The email address associated with the entity, if any.

entity String

The entity holding the permission, in one of the following forms:

user-userId
user-email
group-groupId
group-email
domain-domain
project-team-projectId
allUsers
allAuthenticatedUsers Examples:
The user liz@example.com would be user-liz@example.com.
The group example@googlegroups.com would be group-example@googlegroups.com.
To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

entityId String

The ID for the entity, if any.

etag String

HTTP 1.1 Entity tag for the access-control entry.

kind String

The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.

projectTeam BucketAccessControlProjectTeamResponse

The project team associated with the entity, if any.

role String

The access permission for the entity.

selfLink String

The link to this access-control entry.

bucket string

The name of the bucket.

domain string

The domain associated with the entity, if any.

email string

The email address associated with the entity, if any.

entity string

The entity holding the permission, in one of the following forms:

user-userId
user-email
group-groupId
group-email
domain-domain
project-team-projectId
allUsers
allAuthenticatedUsers Examples:
The user liz@example.com would be user-liz@example.com.
The group example@googlegroups.com would be group-example@googlegroups.com.
To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

entityId string

The ID for the entity, if any.

etag string

HTTP 1.1 Entity tag for the access-control entry.

kind string

The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.

projectTeam BucketAccessControlProjectTeamResponse

The project team associated with the entity, if any.

role string

The access permission for the entity.

selfLink string

The link to this access-control entry.

bucket str

The name of the bucket.

domain str

The domain associated with the entity, if any.

email str

The email address associated with the entity, if any.

entity str

The entity holding the permission, in one of the following forms:

user-userId
user-email
group-groupId
group-email
domain-domain
project-team-projectId
allUsers
allAuthenticatedUsers Examples:
The user liz@example.com would be user-liz@example.com.
The group example@googlegroups.com would be group-example@googlegroups.com.
To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

entity_id str

The ID for the entity, if any.

etag str

HTTP 1.1 Entity tag for the access-control entry.

kind str

The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.

project_team BucketAccessControlProjectTeamResponse

The project team associated with the entity, if any.

role str

The access permission for the entity.

self_link str

The link to this access-control entry.

bucket String

The name of the bucket.

domain String

The domain associated with the entity, if any.

email String

The email address associated with the entity, if any.

entity String

The entity holding the permission, in one of the following forms:

user-userId
user-email
group-groupId
group-email
domain-domain
project-team-projectId
allUsers
allAuthenticatedUsers Examples:
The user liz@example.com would be user-liz@example.com.
The group example@googlegroups.com would be group-example@googlegroups.com.
To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

entityId String

The ID for the entity, if any.

etag String

HTTP 1.1 Entity tag for the access-control entry.

kind String

The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.

projectTeam Property Map

The project team associated with the entity, if any.

role String

The access permission for the entity.

selfLink String

The link to this access-control entry.

BucketAutoclassResponse

Enabled bool: Whether or not Autoclass is enabled on this bucket
ToggleTime string: A date and time in RFC 3339 format representing the instant at which "enabled" was last toggled.

Enabled bool: Whether or not Autoclass is enabled on this bucket
ToggleTime string: A date and time in RFC 3339 format representing the instant at which "enabled" was last toggled.

enabled Boolean: Whether or not Autoclass is enabled on this bucket
toggleTime String: A date and time in RFC 3339 format representing the instant at which "enabled" was last toggled.

enabled boolean: Whether or not Autoclass is enabled on this bucket
toggleTime string: A date and time in RFC 3339 format representing the instant at which "enabled" was last toggled.

enabled bool: Whether or not Autoclass is enabled on this bucket
toggle_time str: A date and time in RFC 3339 format representing the instant at which "enabled" was last toggled.

enabled Boolean: Whether or not Autoclass is enabled on this bucket
toggleTime String: A date and time in RFC 3339 format representing the instant at which "enabled" was last toggled.

BucketBillingResponse

RequesterPays bool: When set to true, Requester Pays is enabled for this bucket.

RequesterPays bool: When set to true, Requester Pays is enabled for this bucket.

requesterPays Boolean: When set to true, Requester Pays is enabled for this bucket.

requesterPays boolean: When set to true, Requester Pays is enabled for this bucket.

requester_pays bool: When set to true, Requester Pays is enabled for this bucket.

requesterPays Boolean: When set to true, Requester Pays is enabled for this bucket.

BucketCorsItemResponse

MaxAgeSeconds int: The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
Method 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".
Origin List<string>: The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
ResponseHeader List<string>: The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.

MaxAgeSeconds int: The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
Method []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".
Origin []string: The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
ResponseHeader []string: The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.

maxAgeSeconds Integer: The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
method 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".
origin List<String>: The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
responseHeader List<String>: The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.

maxAgeSeconds number: The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
method 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".
origin string[]: The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
responseHeader 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_seconds int: The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
method 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".
origin 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_header Sequence[str]: The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.

maxAgeSeconds Number: The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
method 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".
origin List<String>: The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
responseHeader List<String>: The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.

BucketCustomPlacementConfigResponse

DataLocations List<string>: The list of regional locations in which data is placed.

DataLocations []string: The list of regional locations in which data is placed.

dataLocations List<String>: The list of regional locations in which data is placed.

dataLocations string[]: The list of regional locations in which data is placed.

data_locations Sequence[str]: The list of regional locations in which data is placed.

dataLocations List<String>: The list of regional locations in which data is placed.

BucketEncryptionResponse

DefaultKmsKeyName string: A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.

DefaultKmsKeyName string: A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.

defaultKmsKeyName String: A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.

defaultKmsKeyName string: A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.

default_kms_key_name str: A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.

defaultKmsKeyName String: A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.

BucketIamConfigurationBucketPolicyOnlyResponse

Enabled bool: If set, access is controlled only by bucket-level or above IAM policies.
LockedTime string: The deadline for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable.

Enabled bool: If set, access is controlled only by bucket-level or above IAM policies.
LockedTime string: The deadline for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable.

enabled Boolean: If set, access is controlled only by bucket-level or above IAM policies.
lockedTime String: The deadline for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable.

enabled boolean: If set, access is controlled only by bucket-level or above IAM policies.
lockedTime string: The deadline for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable.

enabled bool: If set, access is controlled only by bucket-level or above IAM policies.
locked_time str: The deadline for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable.

enabled Boolean: If set, access is controlled only by bucket-level or above IAM policies.
lockedTime String: The deadline for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable.

BucketIamConfigurationResponse

BucketPolicyOnly Pulumi.GoogleNative.Storage.V1.Inputs.BucketIamConfigurationBucketPolicyOnlyResponse: The bucket's uniform bucket-level access configuration. The feature was formerly known as Bucket Policy Only. For backward compatibility, this field will be populated with identical information as the uniformBucketLevelAccess field. We recommend using the uniformBucketLevelAccess field to enable and disable the feature.
PublicAccessPrevention string: The bucket's Public Access Prevention configuration. Currently, 'inherited' and 'enforced' are supported.
UniformBucketLevelAccess Pulumi.GoogleNative.Storage.V1.Inputs.BucketIamConfigurationUniformBucketLevelAccessResponse: The bucket's uniform bucket-level access configuration.

BucketPolicyOnly BucketIamConfigurationBucketPolicyOnlyResponse: The bucket's uniform bucket-level access configuration. The feature was formerly known as Bucket Policy Only. For backward compatibility, this field will be populated with identical information as the uniformBucketLevelAccess field. We recommend using the uniformBucketLevelAccess field to enable and disable the feature.
PublicAccessPrevention string: The bucket's Public Access Prevention configuration. Currently, 'inherited' and 'enforced' are supported.
UniformBucketLevelAccess BucketIamConfigurationUniformBucketLevelAccessResponse: The bucket's uniform bucket-level access configuration.

bucketPolicyOnly BucketIamConfigurationBucketPolicyOnlyResponse: The bucket's uniform bucket-level access configuration. The feature was formerly known as Bucket Policy Only. For backward compatibility, this field will be populated with identical information as the uniformBucketLevelAccess field. We recommend using the uniformBucketLevelAccess field to enable and disable the feature.
publicAccessPrevention String: The bucket's Public Access Prevention configuration. Currently, 'inherited' and 'enforced' are supported.
uniformBucketLevelAccess BucketIamConfigurationUniformBucketLevelAccessResponse: The bucket's uniform bucket-level access configuration.

bucketPolicyOnly BucketIamConfigurationBucketPolicyOnlyResponse: The bucket's uniform bucket-level access configuration. The feature was formerly known as Bucket Policy Only. For backward compatibility, this field will be populated with identical information as the uniformBucketLevelAccess field. We recommend using the uniformBucketLevelAccess field to enable and disable the feature.
publicAccessPrevention string: The bucket's Public Access Prevention configuration. Currently, 'inherited' and 'enforced' are supported.
uniformBucketLevelAccess BucketIamConfigurationUniformBucketLevelAccessResponse: The bucket's uniform bucket-level access configuration.

bucket_policy_only BucketIamConfigurationBucketPolicyOnlyResponse: The bucket's uniform bucket-level access configuration. The feature was formerly known as Bucket Policy Only. For backward compatibility, this field will be populated with identical information as the uniformBucketLevelAccess field. We recommend using the uniformBucketLevelAccess field to enable and disable the feature.
public_access_prevention str: The bucket's Public Access Prevention configuration. Currently, 'inherited' and 'enforced' are supported.
uniform_bucket_level_access BucketIamConfigurationUniformBucketLevelAccessResponse: The bucket's uniform bucket-level access configuration.

bucketPolicyOnly Property Map: The bucket's uniform bucket-level access configuration. The feature was formerly known as Bucket Policy Only. For backward compatibility, this field will be populated with identical information as the uniformBucketLevelAccess field. We recommend using the uniformBucketLevelAccess field to enable and disable the feature.
publicAccessPrevention String: The bucket's Public Access Prevention configuration. Currently, 'inherited' and 'enforced' are supported.
uniformBucketLevelAccess Property Map: The bucket's uniform bucket-level access configuration.

BucketIamConfigurationUniformBucketLevelAccessResponse

Enabled bool: If set, access is controlled only by bucket-level or above IAM policies.
LockedTime string: The deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled may be changed from true to false until the locked time, after which the field is immutable.

Enabled bool: If set, access is controlled only by bucket-level or above IAM policies.
LockedTime string: The deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled may be changed from true to false until the locked time, after which the field is immutable.

enabled Boolean: If set, access is controlled only by bucket-level or above IAM policies.
lockedTime String: The deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled may be changed from true to false until the locked time, after which the field is immutable.

enabled boolean: If set, access is controlled only by bucket-level or above IAM policies.
lockedTime string: The deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled may be changed from true to false until the locked time, after which the field is immutable.

enabled bool: If set, access is controlled only by bucket-level or above IAM policies.
locked_time str: The deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled may be changed from true to false until the locked time, after which the field is immutable.

enabled Boolean: If set, access is controlled only by bucket-level or above IAM policies.
lockedTime String: The deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled may be changed from true to false until the locked time, after which the field is immutable.

BucketLifecycleResponse

Rule List<Pulumi.GoogleNative.Storage.V1.Inputs.BucketLifecycleRuleItemResponse>: A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.

Rule []BucketLifecycleRuleItemResponse: A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.

rule List<BucketLifecycleRuleItemResponse>: A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.

rule BucketLifecycleRuleItemResponse[]: A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.

rule Sequence[BucketLifecycleRuleItemResponse]: A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.

rule List<Property Map>: A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.

BucketLifecycleRuleItemActionResponse

StorageClass string: Target storage class. Required iff the type of the action is SetStorageClass.
Type string: Type of the action. Currently, only Delete, SetStorageClass, and AbortIncompleteMultipartUpload are supported.

StorageClass string: Target storage class. Required iff the type of the action is SetStorageClass.
Type string: Type of the action. Currently, only Delete, SetStorageClass, and AbortIncompleteMultipartUpload are supported.

storageClass String: Target storage class. Required iff the type of the action is SetStorageClass.
type String: Type of the action. Currently, only Delete, SetStorageClass, and AbortIncompleteMultipartUpload are supported.

storageClass string: Target storage class. Required iff the type of the action is SetStorageClass.
type string: Type of the action. Currently, only Delete, SetStorageClass, and AbortIncompleteMultipartUpload are supported.

storage_class str: Target storage class. Required iff the type of the action is SetStorageClass.
type str: Type of the action. Currently, only Delete, SetStorageClass, and AbortIncompleteMultipartUpload are supported.

storageClass String: Target storage class. Required iff the type of the action is SetStorageClass.
type String: Type of the action. Currently, only Delete, SetStorageClass, and AbortIncompleteMultipartUpload are supported.

BucketLifecycleRuleItemConditionResponse

Age int: Age of an object (in days). This condition is satisfied when an object reaches the specified age.
CreatedBefore string: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
CustomTimeBefore string: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the custom time on an object is before this date in UTC.
DaysSinceCustomTime int: Number of days elapsed since the user-specified timestamp set on an object. The condition is satisfied if the days elapsed is at least this number. If no custom timestamp is specified on an object, the condition does not apply.
DaysSinceNoncurrentTime int: Number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. This condition is relevant only for versioned objects. The value of the field must be a nonnegative integer. If it's zero, the object version will become eligible for Lifecycle action as soon as it becomes noncurrent.
IsLive bool: Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
MatchesPattern string: A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the "Early Access" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released.
MatchesPrefix List<string>: List of object name prefixes. This condition will be satisfied when at least one of the prefixes exactly matches the beginning of the object name.
MatchesStorageClass List<string>: Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
MatchesSuffix List<string>: List of object name suffixes. This condition will be satisfied when at least one of the suffixes exactly matches the end of the object name.
NoncurrentTimeBefore string: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects.
NumNewerVersions int: Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.

Age int: Age of an object (in days). This condition is satisfied when an object reaches the specified age.
CreatedBefore string: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
CustomTimeBefore string: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the custom time on an object is before this date in UTC.
DaysSinceCustomTime int: Number of days elapsed since the user-specified timestamp set on an object. The condition is satisfied if the days elapsed is at least this number. If no custom timestamp is specified on an object, the condition does not apply.
DaysSinceNoncurrentTime int: Number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. This condition is relevant only for versioned objects. The value of the field must be a nonnegative integer. If it's zero, the object version will become eligible for Lifecycle action as soon as it becomes noncurrent.
IsLive bool: Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
MatchesPattern string: A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the "Early Access" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released.
MatchesPrefix []string: List of object name prefixes. This condition will be satisfied when at least one of the prefixes exactly matches the beginning of the object name.
MatchesStorageClass []string: Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
MatchesSuffix []string: List of object name suffixes. This condition will be satisfied when at least one of the suffixes exactly matches the end of the object name.
NoncurrentTimeBefore string: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects.
NumNewerVersions int: Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.

age Integer: Age of an object (in days). This condition is satisfied when an object reaches the specified age.
createdBefore String: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
customTimeBefore String: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the custom time on an object is before this date in UTC.
daysSinceCustomTime Integer: Number of days elapsed since the user-specified timestamp set on an object. The condition is satisfied if the days elapsed is at least this number. If no custom timestamp is specified on an object, the condition does not apply.
daysSinceNoncurrentTime Integer: Number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. This condition is relevant only for versioned objects. The value of the field must be a nonnegative integer. If it's zero, the object version will become eligible for Lifecycle action as soon as it becomes noncurrent.
isLive Boolean: Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
matchesPattern String: A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the "Early Access" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released.
matchesPrefix List<String>: List of object name prefixes. This condition will be satisfied when at least one of the prefixes exactly matches the beginning of the object name.
matchesStorageClass List<String>: Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
matchesSuffix List<String>: List of object name suffixes. This condition will be satisfied when at least one of the suffixes exactly matches the end of the object name.
noncurrentTimeBefore String: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects.
numNewerVersions Integer: Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.

age number: Age of an object (in days). This condition is satisfied when an object reaches the specified age.
createdBefore string: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
customTimeBefore string: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the custom time on an object is before this date in UTC.
daysSinceCustomTime number: Number of days elapsed since the user-specified timestamp set on an object. The condition is satisfied if the days elapsed is at least this number. If no custom timestamp is specified on an object, the condition does not apply.
daysSinceNoncurrentTime number: Number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. This condition is relevant only for versioned objects. The value of the field must be a nonnegative integer. If it's zero, the object version will become eligible for Lifecycle action as soon as it becomes noncurrent.
isLive boolean: Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
matchesPattern string: A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the "Early Access" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released.
matchesPrefix string[]: List of object name prefixes. This condition will be satisfied when at least one of the prefixes exactly matches the beginning of the object name.
matchesStorageClass string[]: Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
matchesSuffix string[]: List of object name suffixes. This condition will be satisfied when at least one of the suffixes exactly matches the end of the object name.
noncurrentTimeBefore string: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects.
numNewerVersions number: Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.

age int: Age of an object (in days). This condition is satisfied when an object reaches the specified age.
created_before str: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
custom_time_before str: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the custom time on an object is before this date in UTC.
days_since_custom_time int: Number of days elapsed since the user-specified timestamp set on an object. The condition is satisfied if the days elapsed is at least this number. If no custom timestamp is specified on an object, the condition does not apply.
days_since_noncurrent_time int: Number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. This condition is relevant only for versioned objects. The value of the field must be a nonnegative integer. If it's zero, the object version will become eligible for Lifecycle action as soon as it becomes noncurrent.
is_live bool: Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
matches_pattern str: A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the "Early Access" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released.
matches_prefix Sequence[str]: List of object name prefixes. This condition will be satisfied when at least one of the prefixes exactly matches the beginning of the object name.
matches_storage_class Sequence[str]: Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
matches_suffix Sequence[str]: List of object name suffixes. This condition will be satisfied when at least one of the suffixes exactly matches the end of the object name.
noncurrent_time_before str: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects.
num_newer_versions int: Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.

age Number: Age of an object (in days). This condition is satisfied when an object reaches the specified age.
createdBefore String: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
customTimeBefore String: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the custom time on an object is before this date in UTC.
daysSinceCustomTime Number: Number of days elapsed since the user-specified timestamp set on an object. The condition is satisfied if the days elapsed is at least this number. If no custom timestamp is specified on an object, the condition does not apply.
daysSinceNoncurrentTime Number: Number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. This condition is relevant only for versioned objects. The value of the field must be a nonnegative integer. If it's zero, the object version will become eligible for Lifecycle action as soon as it becomes noncurrent.
isLive Boolean: Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
matchesPattern String: A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the "Early Access" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released.
matchesPrefix List<String>: List of object name prefixes. This condition will be satisfied when at least one of the prefixes exactly matches the beginning of the object name.
matchesStorageClass List<String>: Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
matchesSuffix List<String>: List of object name suffixes. This condition will be satisfied when at least one of the suffixes exactly matches the end of the object name.
noncurrentTimeBefore String: A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects.
numNewerVersions Number: Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.

BucketLifecycleRuleItemResponse

Action Pulumi.GoogleNative.Storage.V1.Inputs.BucketLifecycleRuleItemActionResponse: The action to take.
Condition Pulumi.GoogleNative.Storage.V1.Inputs.BucketLifecycleRuleItemConditionResponse: The condition(s) under which the action will be taken.

Action BucketLifecycleRuleItemActionResponse: The action to take.
Condition BucketLifecycleRuleItemConditionResponse: The condition(s) under which the action will be taken.

action BucketLifecycleRuleItemActionResponse: The action to take.
condition BucketLifecycleRuleItemConditionResponse: The condition(s) under which the action will be taken.

action BucketLifecycleRuleItemActionResponse: The action to take.
condition BucketLifecycleRuleItemConditionResponse: The condition(s) under which the action will be taken.

action BucketLifecycleRuleItemActionResponse: The action to take.
condition BucketLifecycleRuleItemConditionResponse: The condition(s) under which the action will be taken.

action Property Map: The action to take.
condition Property Map: The condition(s) under which the action will be taken.

BucketLoggingResponse

LogBucket string: The destination bucket where the current bucket's logs should be placed.
LogObjectPrefix string: A prefix for log object names.

LogBucket string: The destination bucket where the current bucket's logs should be placed.
LogObjectPrefix string: A prefix for log object names.

logBucket String: The destination bucket where the current bucket's logs should be placed.
logObjectPrefix String: A prefix for log object names.

logBucket string: The destination bucket where the current bucket's logs should be placed.
logObjectPrefix string: A prefix for log object names.

log_bucket str: The destination bucket where the current bucket's logs should be placed.
log_object_prefix str: A prefix for log object names.

logBucket String: The destination bucket where the current bucket's logs should be placed.
logObjectPrefix String: A prefix for log object names.

BucketOwnerResponse

Entity string: The entity, in the form project-owner-projectId.
EntityId string: The ID for the entity.

Entity string: The entity, in the form project-owner-projectId.
EntityId string: The ID for the entity.

entity String: The entity, in the form project-owner-projectId.
entityId String: The ID for the entity.

entity string: The entity, in the form project-owner-projectId.
entityId string: The ID for the entity.

entity str: The entity, in the form project-owner-projectId.
entity_id str: The ID for the entity.

entity String: The entity, in the form project-owner-projectId.
entityId String: The ID for the entity.

BucketRetentionPolicyResponse

EffectiveTime string: Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.
IsLocked bool: Once locked, an object retention policy cannot be modified.
RetentionPeriod string: The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.

EffectiveTime string: Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.
IsLocked bool: Once locked, an object retention policy cannot be modified.
RetentionPeriod string: The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.

effectiveTime String: Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.
isLocked Boolean: Once locked, an object retention policy cannot be modified.
retentionPeriod String: The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.

effectiveTime string: Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.
isLocked boolean: Once locked, an object retention policy cannot be modified.
retentionPeriod string: The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.

effective_time str: Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.
is_locked bool: Once locked, an object retention policy cannot be modified.
retention_period str: The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.

effectiveTime String: Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.
isLocked Boolean: Once locked, an object retention policy cannot be modified.
retentionPeriod String: The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.

BucketVersioningResponse

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.

BucketWebsiteResponse

MainPageSuffix string: If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
NotFoundPage string: If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.

MainPageSuffix string: If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
NotFoundPage string: If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.

mainPageSuffix String: If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
notFoundPage String: If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.

mainPageSuffix string: If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
notFoundPage string: If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.

main_page_suffix str: If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
not_found_page str: If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.

mainPageSuffix String: If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
notFoundPage String: If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.

ObjectAccessControlProjectTeamResponse

ProjectNumber string: The project number.
Team string: The team.

ProjectNumber string: The project number.
Team string: The team.

projectNumber String: The project number.
team String: The team.

projectNumber string: The project number.
team string: The team.

project_number str: The project number.
team str: The team.

projectNumber String: The project number.
team String: The team.

ObjectAccessControlResponse

Bucket string

The name of the bucket.

Domain string

The domain associated with the entity, if any.

Email string

The email address associated with the entity, if any.

Entity string

The entity holding the permission, in one of the following forms:

user-userId
user-email
group-groupId
group-email
domain-domain
project-team-projectId
allUsers
allAuthenticatedUsers Examples:
The user liz@example.com would be user-liz@example.com.
The group example@googlegroups.com would be group-example@googlegroups.com.
To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

EntityId string

The ID for the entity, if any.

Etag string

HTTP 1.1 Entity tag for the access-control entry.

Generation string

The content generation of the object, if applied to an object.

Kind string

The kind of item this is. For object access control entries, this is always storage#objectAccessControl.

Object string

The name of the object, if applied to an object.

ProjectTeam Pulumi.GoogleNative.Storage.V1.Inputs.ObjectAccessControlProjectTeamResponse

The project team associated with the entity, if any.

Role string

The access permission for the entity.

SelfLink string

The link to this access-control entry.

Bucket string

The name of the bucket.

Domain string

The domain associated with the entity, if any.

Email string

The email address associated with the entity, if any.

Entity string

The entity holding the permission, in one of the following forms:

user-userId
user-email
group-groupId
group-email
domain-domain
project-team-projectId
allUsers
allAuthenticatedUsers Examples:
The user liz@example.com would be user-liz@example.com.
The group example@googlegroups.com would be group-example@googlegroups.com.
To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

EntityId string

The ID for the entity, if any.

Etag string

HTTP 1.1 Entity tag for the access-control entry.

Generation string

The content generation of the object, if applied to an object.

Kind string

The kind of item this is. For object access control entries, this is always storage#objectAccessControl.

Object string

The name of the object, if applied to an object.

ProjectTeam ObjectAccessControlProjectTeamResponse

The project team associated with the entity, if any.

Role string

The access permission for the entity.

SelfLink string

The link to this access-control entry.

bucket String

The name of the bucket.

domain String

The domain associated with the entity, if any.

email String

The email address associated with the entity, if any.

entity String

The entity holding the permission, in one of the following forms:

user-userId
user-email
group-groupId
group-email
domain-domain
project-team-projectId
allUsers
allAuthenticatedUsers Examples:
The user liz@example.com would be user-liz@example.com.
The group example@googlegroups.com would be group-example@googlegroups.com.
To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

entityId String

The ID for the entity, if any.

etag String

HTTP 1.1 Entity tag for the access-control entry.

generation String

The content generation of the object, if applied to an object.

kind String

The kind of item this is. For object access control entries, this is always storage#objectAccessControl.

object String

The name of the object, if applied to an object.

projectTeam ObjectAccessControlProjectTeamResponse

The project team associated with the entity, if any.

role String

The access permission for the entity.

selfLink String

The link to this access-control entry.

bucket string

The name of the bucket.

domain string

The domain associated with the entity, if any.

email string

The email address associated with the entity, if any.

entity string

The entity holding the permission, in one of the following forms:

user-userId
user-email
group-groupId
group-email
domain-domain
project-team-projectId
allUsers
allAuthenticatedUsers Examples:
The user liz@example.com would be user-liz@example.com.
The group example@googlegroups.com would be group-example@googlegroups.com.
To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

entityId string

The ID for the entity, if any.

etag string

HTTP 1.1 Entity tag for the access-control entry.

generation string

The content generation of the object, if applied to an object.

kind string

The kind of item this is. For object access control entries, this is always storage#objectAccessControl.

object string

The name of the object, if applied to an object.

projectTeam ObjectAccessControlProjectTeamResponse

The project team associated with the entity, if any.

role string

The access permission for the entity.

selfLink string

The link to this access-control entry.

bucket str

The name of the bucket.

domain str

The domain associated with the entity, if any.

email str

The email address associated with the entity, if any.

entity str

The entity holding the permission, in one of the following forms:

user-userId
user-email
group-groupId
group-email
domain-domain
project-team-projectId
allUsers
allAuthenticatedUsers Examples:
The user liz@example.com would be user-liz@example.com.
The group example@googlegroups.com would be group-example@googlegroups.com.
To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

entity_id str

The ID for the entity, if any.

etag str

HTTP 1.1 Entity tag for the access-control entry.

generation str

The content generation of the object, if applied to an object.

kind str

The kind of item this is. For object access control entries, this is always storage#objectAccessControl.

object str

The name of the object, if applied to an object.

project_team ObjectAccessControlProjectTeamResponse

The project team associated with the entity, if any.

role str

The access permission for the entity.

self_link str

The link to this access-control entry.

bucket String

The name of the bucket.

domain String

The domain associated with the entity, if any.

email String

The email address associated with the entity, if any.

entity String

The entity holding the permission, in one of the following forms:

user-userId
user-email
group-groupId
group-email
domain-domain
project-team-projectId
allUsers
allAuthenticatedUsers Examples:
The user liz@example.com would be user-liz@example.com.
The group example@googlegroups.com would be group-example@googlegroups.com.
To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

entityId String

The ID for the entity, if any.

etag String

HTTP 1.1 Entity tag for the access-control entry.

generation String

The content generation of the object, if applied to an object.

kind String

The kind of item this is. For object access control entries, this is always storage#objectAccessControl.

object String

The name of the object, if applied to an object.

projectTeam Property Map

The project team associated with the entity, if any.

role String

The access permission for the entity.

selfLink String

The link to this access-control entry.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.storage/v1.getBucket

On this page

On this page

Using getBucket

getBucket Result

Supporting Types

BucketAccessControlProjectTeamResponse

BucketAccessControlResponse

BucketAutoclassResponse

BucketBillingResponse

BucketCorsItemResponse

BucketCustomPlacementConfigResponse

BucketEncryptionResponse

BucketIamConfigurationBucketPolicyOnlyResponse

BucketIamConfigurationResponse

BucketIamConfigurationUniformBucketLevelAccessResponse

BucketLifecycleResponse

BucketLifecycleRuleItemActionResponse

BucketLifecycleRuleItemConditionResponse

BucketLifecycleRuleItemResponse

BucketLoggingResponse

BucketOwnerResponse

BucketRetentionPolicyResponse

BucketVersioningResponse

BucketWebsiteResponse

ObjectAccessControlProjectTeamResponse

ObjectAccessControlResponse

Package Details

On this page

On this page