|
6 | 6 |
|
7 | 7 | The following attributes are exported: |
8 | 8 |
|
9 | | -* `access_type` - The type of public access available on this bucket. Allows authenticated caller to access the bucket or contents of this bucket. By default a bucket is set to NoPublicAccess. It is treated as NoPublicAccess when this value is not specified. When the type is NoPublicAccess the bucket does not allow any public access. When the type is ObjectRead the bucket allows public access to the GetObject, HeadObject, ListObjects. |
| 9 | +* `access_type` - The type of public access enabled on this bucket. A bucket is set to `NoPublicAccess` by default, which only allows an authenticated caller to access the bucket and its contents. When `ObjectRead` is enabled on the bucket, public access is allowed for the `GetObject`, `HeadObject`, and `ListObjects` operations. When `ObjectReadWithoutList` is enabled on the bucket, public access is allowed for the `GetObject` and `HeadObject` operations. |
10 | 10 | * `compartment_id` - The compartment ID in which the bucket is authorized. |
11 | 11 | * `created_by` - The OCID of the user who created the bucket. |
12 | 12 | * `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` |
13 | 13 | * `etag` - The entity tag for the bucket. |
14 | 14 | * `freeform_tags` - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` |
15 | 15 | * `metadata` - Arbitrary string keys and values for user-defined metadata. |
16 | | -* `name` - The name of the bucket. |
| 16 | +* `name` - The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1 |
17 | 17 | * `namespace` - The namespace in which the bucket lives. |
18 | 18 | * `storage_tier` - The type of storage tier of this bucket. A bucket is set to 'Standard' tier by default, which means the bucket will be put in the standard storage tier. When 'Archive' tier type is set explicitly, the bucket is put in the archive storage tier. The 'storageTier' property is immutable after bucket is created. |
19 | | -* `time_created` - The date and time at which the bucket was created. |
| 19 | +* `time_created` - The date and time the bucket was created, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29. |
20 | 20 |
|
21 | 21 |
|
22 | 22 |
|
23 | 23 | ### Create Operation |
24 | 24 | Creates a bucket in the given namespace with a bucket name and optional user-defined metadata. |
25 | 25 |
|
26 | | -To use this and other API operations, you must be authorized in an IAM policy. If you're not authorized, |
27 | | -talk to an administrator. If you're an administrator who needs to write policies to give users access, see |
28 | | -[Getting Started with Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). |
29 | | - |
30 | 26 |
|
31 | 27 | The following arguments are supported: |
32 | 28 |
|
33 | | -* `access_type` - (Optional) The type of public access available on this bucket. Allows authenticated caller to access the bucket or contents of this bucket. By default a bucket is set to NoPublicAccess. It is treated as NoPublicAccess when this value is not specified. When the type is NoPublicAccess the bucket does not allow any public access. When the type is ObjectRead the bucket allows public access to the GetObject, HeadObject, ListObjects. |
| 29 | +* `access_type` - (Optional) The type of public access enabled on this bucket. A bucket is set to `NoPublicAccess` by default, which only allows an authenticated caller to access the bucket and its contents. When `ObjectRead` is enabled on the bucket, public access is allowed for the `GetObject`, `HeadObject`, and `ListObjects` operations. When `ObjectReadWithoutList` is enabled on the bucket, public access is allowed for the `GetObject` and `HeadObject` operations. |
34 | 30 | * `compartment_id` - (Required) The ID of the compartment in which to create the bucket. |
35 | 31 | * `defined_tags` - (Optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` |
36 | 32 | * `freeform_tags` - (Optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` |
37 | 33 | * `metadata` - (Optional) Arbitrary string, up to 4KB, of keys and values for user-defined metadata. |
38 | | -* `name` - (Required) The name of the bucket. Valid characters are uppercase or lowercase letters, numbers, and dashes. Bucket names must be unique within the namespace. |
| 34 | +* `name` - (Required) The name of the bucket. Valid characters are uppercase or lowercase letters, numbers, and dashes. Bucket names must be unique within the namespace. Avoid entering confidential information. example: Example: my-new-bucket1 |
39 | 35 | * `namespace` - (Required) The top-level namespace used for the request. |
40 | 36 | * `storage_tier` - (Optional) The type of storage tier of this bucket. A bucket is set to 'Standard' tier by default, which means the bucket will be put in the standard storage tier. When 'Archive' tier type is set explicitly, the bucket is put in the Archive Storage tier. The 'storageTier' property is immutable after bucket is created. |
41 | 37 |
|
42 | 38 |
|
43 | 39 | ### Update Operation |
| 40 | +Performs a partial or full update of a bucket's user-defined metadata. |
| 41 | + |
44 | 42 |
|
45 | 43 | The following arguments support updates: |
46 | | -* `access_type` - The type of public access available on this bucket. Allows authenticated caller to access the bucket or contents of this bucket. By default a bucket is set to NoPublicAccess. It is treated as NoPublicAccess when this value is not specified. When the type is NoPublicAccess the bucket does not allow any public access. When the type is ObjectRead the bucket allows public access to the GetObject, HeadObject, ListObjects. |
| 44 | +* `access_type` - The type of public access enabled on this bucket. A bucket is set to `NoPublicAccess` by default, which only allows an authenticated caller to access the bucket and its contents. When `ObjectRead` is enabled on the bucket, public access is allowed for the `GetObject`, `HeadObject`, and `ListObjects` operations. When `ObjectReadWithoutList` is enabled on the bucket, public access is allowed for the `GetObject` and `HeadObject` operations. |
| 45 | +* `compartment_id` - The ID of the compartment in which to create the bucket. |
47 | 46 | * `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` |
48 | 47 | * `freeform_tags` - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` |
49 | 48 | * `metadata` - Arbitrary string, up to 4KB, of keys and values for user-defined metadata. |
@@ -79,8 +78,8 @@ Gets a list of buckets. |
79 | 78 | Gets a list of all `BucketSummary`s in a compartment. A `BucketSummary` contains only summary fields for the bucket |
80 | 79 | and does not contain fields like the user-defined metadata. |
81 | 80 |
|
82 | | -To use this and other API operations, you must be authorized in an IAM policy. If you're not authorized, |
83 | | -talk to an administrator. If you're an administrator who needs to write policies to give users access, see |
| 81 | +To use this and other API operations, you must be authorized in an IAM policy. If you're not authorized, |
| 82 | +talk to an administrator. If you're an administrator who needs to write policies to give users access, see |
84 | 83 | [Getting Started with Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). |
85 | 84 |
|
86 | 85 | The following arguments are supported: |
|
0 commit comments