Idem.GCP.STORAGE.BUCKET
{
"account": "string",
"acl": [
{
"bucket": "string",
"domain": "string",
"email": "string",
"entity": "string",
"entity_id": "string",
"etag": "string",
"id": "string",
"kind": "string",
"project_team": {
"project_number": "string",
"team": "string"
},
"role": "string",
"self_link": "string"
}
],
"autoclass": {
"enabled": false
},
"billing": {
"requester_pays": false
},
"cors": [
{
"max_age_seconds": 0,
"method": [
{}
],
"origin": [
{}
],
"response_header": [
{}
]
}
],
"count": 0,
"custom_placement_config": {
"data_locations": [
"string"
]
},
"default_event_based_hold": false,
"default_object_acl": [
{
"domain": "string",
"email": "string",
"entity": "string",
"entity_id": "string",
"etag": "string",
"kind": "string",
"project_team": {
"project_number": "string",
"team": "string"
},
"role": "string"
}
],
"encryption": {
"default_kms_key_name": "string"
},
"iam_configuration": {
"bucket_policy_only": {
"enabled": false,
"locked_time": "string"
},
"public_access_prevention": "string",
"uniform_bucket_level_access": {
"enabled": false,
"locked_time": "string"
}
},
"if_metageneration_match": "string",
"lifecycle": {
"rule": [
{
"action": {
"storage_class": "string"
},
"condition": {
"age": 0,
"created_before": "string",
"custom_time_before": "string",
"days_since_custom_time": 0,
"days_since_noncurrent_time": 0,
"is_live": false,
"matches_pattern": "string",
"matches_prefix": [
"string"
],
"matches_storage_class": [
"string"
],
"matches_suffix": [
"string"
],
"noncurrent_time_before": "string",
"num_newer_versions": 0
}
}
]
},
"location": "string",
"logging": {
"log_bucket": "string",
"log_object_prefix": "string"
},
"metageneration": "string",
"name": "string",
"predefined_acl": "string",
"predefined_default_object_acl": "string",
"project": "string",
"resource_id": "string",
"retention_policy": {
"is_locked": false,
"retention_period": "string"
},
"rpo": "string",
"storage_class": "string",
"user_project": "string",
"versioning": {
"enabled": false
},
"website": {
"main_page_suffix": "string",
"not_found_page": "string"
}
}
The name of the vRA cloud account to use during provisioning
Access controls on the bucket. Defaults to None.
- bucket (str, Optional): [OutputOnly] The name of the bucket.
- domain (str, Optional): [OutputOnly] The domain associated with the entity, if any.
- email (str, Optional): [OutputOnly] The email address associated with the entity, if any.
- entity (str, Optional): 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 [email protected] would be [email protected].
- The group [email protected] would be [email protected].
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
- entity_id (str, Optional): [OutputOnly] The ID for the entity, if any.
- etag (str, Optional): [OutputOnly] HTTP 1.1 Entity tag for the access-control entry.
- id (str, Optional): [OutputOnly] The ID of the access-control entry.
- kind (str, Optional): [OutputOnly] The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- project_team (Dict[str, Any], Optional): [OutputOnly] The project team associated with the entity, if any.
- project_number (str, Optional): [OutputOnly] The project number.
- team (str, Optional): [OutputOnly] The team.
- role (str, Optional): The access permission for the entity.
- self_link (str, Optional): [OutputOnly] The link to this access-control entry.
The bucket's Autoclass configuration. Defaults to None.
The bucket's billing configuration. Defaults to None.
The bucket's Cross-Origin Resource Sharing (CORS) configuration. Defaults to None.
The number of resource instances to be created.
The bucket's custom placement configuration for Custom Dual Regions. Defaults to None.
- data_locations (List[str], Optional): The list of regional locations in which data is placed.
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. Defaults to None.
Default access controls to apply to new objects when no ACL is provided. Defaults to None.
- domain (str, Optional): [OutputOnly] The domain associated with the entity, if any.
- email (str, Optional): [OutputOnly] The email address associated with the entity, if any.
- entity (str, Optional): 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 [email protected] would be [email protected].
- The group [email protected] would be [email protected].
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
- entity_id (str, Optional): [OutputOnly] The ID for the entity, if any.
- etag (str, Optional): [OutputOnly] HTTP 1.1 Entity tag for the access-control entry.
- kind (str, Optional): [OutputOnly] The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- project_team (Dict[str, Any], Optional): [OutputOnly] The project team associated with the entity, if any.
- project_number (str, Optional): [OutputOnly] The project number.
- team (str, Optional): [OutputOnly] The team.
- role (str, Optional): The access permission for the entity.
Encryption configuration for a bucket. Defaults to None.
The bucket's IAM configuration. Defaults to None.
Makes the operation conditional on whether bucket's current metageneration matches the given value. Currently used only when locking retention policy
User-provided labels, in key/value pairs. Defaults to None.
The bucket's lifecycle configuration. See lifecycle management for more information. Defaults to None.
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. Defaults to None.
The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. Defaults to None.
The metadata generation of this bucket. Read-only property
An Idem name of the resource.
Apply a predefined set of access controls to this bucket. Defaults to None.
Apply a predefined set of default object access controls to this bucket. Defaults to None.
A valid API project identifier.
An identifier of the resource in the provider. Defaults to None.
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. Defaults to None.
The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket. Defaults to None.
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. Defaults to None.
The project to be billed for this request. Required for Requester Pays buckets. Defaults to None.
The bucket's versioning configuration. Defaults to None.
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. Defaults to None.