UpdateBucketDetails¶

class oci.object_storage.models.UpdateBucketDetails(**kwargs)¶

Bases: object

To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see `Getting Started with Policies`__.

Attributes:

`PUBLIC_ACCESS_TYPE_NO_PUBLIC_ACCESS`	A constant which can be used with the public_access_type property of a UpdateBucketDetails.
`PUBLIC_ACCESS_TYPE_OBJECT_READ`	A constant which can be used with the public_access_type property of a UpdateBucketDetails.
`PUBLIC_ACCESS_TYPE_OBJECT_READ_WITHOUT_LIST`	A constant which can be used with the public_access_type property of a UpdateBucketDetails.
`VERSIONING_ENABLED`	A constant which can be used with the versioning property of a UpdateBucketDetails.
`VERSIONING_SUSPENDED`	A constant which can be used with the versioning property of a UpdateBucketDetails.
`auto_tiering`	Gets the auto_tiering of this UpdateBucketDetails.
`bucket_scope`	Gets the bucket_scope of this UpdateBucketDetails.
`compartment_id`	Gets the compartment_id of this UpdateBucketDetails.
`defined_tags`	Gets the defined_tags of this UpdateBucketDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__. Example: `{"Operations": {"CostCenter": "42"}}.
`freeform_tags`	Gets the freeform_tags of this UpdateBucketDetails.
`is_bucket_key_enabled`	Gets the is_bucket_key_enabled of this UpdateBucketDetails.
`kms_key_id`	Gets the kms_key_id of this UpdateBucketDetails.
`metadata`	Gets the metadata of this UpdateBucketDetails.
`name`	Gets the name of this UpdateBucketDetails.
`namespace`	Gets the namespace of this UpdateBucketDetails.
`object_events_enabled`	Gets the object_events_enabled of this UpdateBucketDetails.
`public_access_type`	Gets the public_access_type of this UpdateBucketDetails.
`versioning`	Gets the versioning of this UpdateBucketDetails.

Methods:

__init__(**kwargs)

Initializes a new UpdateBucketDetails object with values from keyword arguments.

PUBLIC_ACCESS_TYPE_NO_PUBLIC_ACCESS = 'NoPublicAccess'¶: A constant which can be used with the public_access_type property of a UpdateBucketDetails. This constant has a value of “NoPublicAccess”

PUBLIC_ACCESS_TYPE_OBJECT_READ = 'ObjectRead'¶: A constant which can be used with the public_access_type property of a UpdateBucketDetails. This constant has a value of “ObjectRead”

PUBLIC_ACCESS_TYPE_OBJECT_READ_WITHOUT_LIST = 'ObjectReadWithoutList'¶: A constant which can be used with the public_access_type property of a UpdateBucketDetails. This constant has a value of “ObjectReadWithoutList”

VERSIONING_ENABLED = 'Enabled'¶: A constant which can be used with the versioning property of a UpdateBucketDetails. This constant has a value of “Enabled”

VERSIONING_SUSPENDED = 'Suspended'¶: A constant which can be used with the versioning property of a UpdateBucketDetails. This constant has a value of “Suspended”

__init__(**kwargs)¶

Initializes a new UpdateBucketDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

namespace (str) – The value to assign to the namespace property of this UpdateBucketDetails.
compartment_id (str) – The value to assign to the compartment_id property of this UpdateBucketDetails.
name (str) – The value to assign to the name property of this UpdateBucketDetails.
metadata (dict(str, str)) – The value to assign to the metadata property of this UpdateBucketDetails.
public_access_type (str) – The value to assign to the public_access_type property of this UpdateBucketDetails. Allowed values for this property are: “NoPublicAccess”, “ObjectRead”, “ObjectReadWithoutList”
object_events_enabled (bool) – The value to assign to the object_events_enabled property of this UpdateBucketDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateBucketDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateBucketDetails.
kms_key_id (str) – The value to assign to the kms_key_id property of this UpdateBucketDetails.
is_bucket_key_enabled (bool) – The value to assign to the is_bucket_key_enabled property of this UpdateBucketDetails.
versioning (str) – The value to assign to the versioning property of this UpdateBucketDetails. Allowed values for this property are: “Enabled”, “Suspended”
auto_tiering (str) – The value to assign to the auto_tiering property of this UpdateBucketDetails.
bucket_scope (str) – The value to assign to the bucket_scope property of this UpdateBucketDetails.

property auto_tiering¶

Gets the auto_tiering of this UpdateBucketDetails. The auto tiering status on the bucket. If in state InfrequentAccess, objects are transitioned automatically between the ‘Standard’ and ‘InfrequentAccess’ tiers based on the access pattern of the objects. When auto tiering is Disabled, there will be no automatic transitions between storage tiers.

Returns: The auto_tiering of this UpdateBucketDetails.
Return type: str

property bucket_scope¶

Gets the bucket_scope of this UpdateBucketDetails. The bucket scope determines weather the bucket name must be unique within the tenancy and region (essentially the namespace) or across all tenancies in the region. The bucket scope also determines if the bucket supports S3 virtual-hosted style URL’s or not.

Allowed values: NAMESPACE: Only supports path-style bucket access, bucket name only needs to be unique within the tenancy and region. REGION: Supports both path-style and virtual-hosted URL style access, bucket name needs to be unique across all tenancies in the region.

BucketScope can only be updated from NAMESPACE to REGION, it cannot be updated from REGION to NAMESPACE. Updating bucket scope is possible only if the bucket name is valid and there is no existing regionally unique bucket with the same name.

Returns: The bucket_scope of this UpdateBucketDetails.
Return type: str

property compartment_id¶

Gets the compartment_id of this UpdateBucketDetails. The compartmentId for the compartment to move the bucket to.

Returns: The compartment_id of this UpdateBucketDetails.
Return type: str

property defined_tags¶

Gets the defined_tags of this UpdateBucketDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__. Example: `{“Operations”: {“CostCenter”: “42”}}

Returns: The defined_tags of this UpdateBucketDetails.
Return type: dict(str, dict(str, object))

property freeform_tags¶

Gets the freeform_tags of this UpdateBucketDetails. 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`__. Example: {“Department”: “Finance”}

Returns: The freeform_tags of this UpdateBucketDetails.
Return type: dict(str, str)

property is_bucket_key_enabled¶

Gets the is_bucket_key_enabled of this UpdateBucketDetails. Specifies whether Object Storage should use intermediate cached Bucket Encryption Keys with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. This reduces calls to OCI Vault Key Management Service (KMS). Existing objects are not affected.

Returns: The is_bucket_key_enabled of this UpdateBucketDetails.
Return type: bool

property kms_key_id¶

Gets the kms_key_id of this UpdateBucketDetails. The `OCID`__ of the Key Management master encryption key to associate with the specified bucket. If this value is empty, the Update operation will remove the associated key, if there is one, from the bucket. (The bucket will continue to be encrypted, but with an encryption key managed by Oracle.)

Returns: The kms_key_id of this UpdateBucketDetails.
Return type: str

property metadata¶

Gets the metadata of this UpdateBucketDetails. Arbitrary string, up to 4KB, of keys and values for user-defined metadata.

Returns: The metadata of this UpdateBucketDetails.
Return type: dict(str, str)

property name¶

Gets the name of this UpdateBucketDetails. The name of the bucket. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. Bucket names must be unique within an Object Storage namespace. Avoid entering confidential information. Example: my-new-bucket1

Returns: The name of this UpdateBucketDetails.
Return type: str

property namespace¶

Gets the namespace of this UpdateBucketDetails. The Object Storage namespace in which the bucket lives.

Returns: The namespace of this UpdateBucketDetails.
Return type: str

property object_events_enabled¶

Gets the object_events_enabled of this UpdateBucketDetails. Whether or not events are emitted for object state changes in this bucket. By default, objectEventsEnabled is set to false. Set objectEventsEnabled to true to emit events for object state changes. For more information about events, see `Overview of Events`__.

Returns: The object_events_enabled of this UpdateBucketDetails.
Return type: bool

property public_access_type¶

Gets the public_access_type of this UpdateBucketDetails. 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.

Allowed values for this property are: “NoPublicAccess”, “ObjectRead”, “ObjectReadWithoutList”

Returns: The public_access_type of this UpdateBucketDetails.
Return type: str

property versioning¶

Gets the versioning of this UpdateBucketDetails. The versioning status on the bucket. If in state Enabled, multiple versions of the same object can be kept in the bucket. When the object is overwritten or deleted, previous versions will still be available. When versioning is Suspended, the previous versions will still remain but new versions will no longer be created when overwitten or deleted. Versioning cannot be disabled on a bucket once enabled.

Allowed values for this property are: “Enabled”, “Suspended”

Returns: The versioning of this UpdateBucketDetails.
Return type: str