CreateBucketDetails¶

class oci.object_storage.models.CreateBucketDetails(**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 CreateBucketDetails.
`PUBLIC_ACCESS_TYPE_OBJECT_READ`	A constant which can be used with the public_access_type property of a CreateBucketDetails.
`PUBLIC_ACCESS_TYPE_OBJECT_READ_WITHOUT_LIST`	A constant which can be used with the public_access_type property of a CreateBucketDetails.
`STORAGE_TIER_ARCHIVE`	A constant which can be used with the storage_tier property of a CreateBucketDetails.
`STORAGE_TIER_STANDARD`	A constant which can be used with the storage_tier property of a CreateBucketDetails.
`VERSIONING_DISABLED`	A constant which can be used with the versioning property of a CreateBucketDetails.
`VERSIONING_ENABLED`	A constant which can be used with the versioning property of a CreateBucketDetails.
`auto_tiering`	Gets the auto_tiering of this CreateBucketDetails.
`bucket_scope`	Gets the bucket_scope of this CreateBucketDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateBucketDetails.
`defined_tags`	Gets the defined_tags of this CreateBucketDetails.
`freeform_tags`	Gets the freeform_tags of this CreateBucketDetails.
`is_bucket_key_enabled`	Gets the is_bucket_key_enabled of this CreateBucketDetails.
`kms_key_id`	Gets the kms_key_id of this CreateBucketDetails.
`metadata`	Gets the metadata of this CreateBucketDetails.
`name`	[Required] Gets the name of this CreateBucketDetails.
`object_events_enabled`	Gets the object_events_enabled of this CreateBucketDetails.
`public_access_type`	Gets the public_access_type of this CreateBucketDetails.
`storage_tier`	Gets the storage_tier of this CreateBucketDetails.
`versioning`	Gets the versioning of this CreateBucketDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateBucketDetails 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 CreateBucketDetails. 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 CreateBucketDetails. 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 CreateBucketDetails. This constant has a value of “ObjectReadWithoutList”

STORAGE_TIER_ARCHIVE = 'Archive'¶: A constant which can be used with the storage_tier property of a CreateBucketDetails. This constant has a value of “Archive”

STORAGE_TIER_STANDARD = 'Standard'¶: A constant which can be used with the storage_tier property of a CreateBucketDetails. This constant has a value of “Standard”

VERSIONING_DISABLED = 'Disabled'¶: A constant which can be used with the versioning property of a CreateBucketDetails. This constant has a value of “Disabled”

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

__init__(**kwargs)¶

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

Parameters

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

property auto_tiering¶

Gets the auto_tiering of this CreateBucketDetails. Set the auto tiering status on the bucket. By default, a bucket is created with auto tiering Disabled. Use this option to enable auto tiering during bucket creation. Objects in a bucket with auto tiering set to InfrequentAccess are transitioned automatically between the ‘Standard’ and ‘InfrequentAccess’ tiers based on the access pattern of the objects.

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

property bucket_scope¶

Gets the bucket_scope of this CreateBucketDetails. 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.

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

property compartment_id¶

[Required] Gets the compartment_id of this CreateBucketDetails. The ID of the compartment in which to create the bucket.

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

property defined_tags¶

Gets the defined_tags of this CreateBucketDetails. 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 CreateBucketDetails.
Return type: dict(str, dict(str, object))

property freeform_tags¶

Gets the freeform_tags of this CreateBucketDetails. 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 CreateBucketDetails.
Return type: dict(str, str)

property is_bucket_key_enabled¶

Gets the is_bucket_key_enabled of this CreateBucketDetails. 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 CreateBucketDetails.
Return type: bool

property kms_key_id¶

Gets the kms_key_id of this CreateBucketDetails. The OCID of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.

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

property metadata¶

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

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

property name¶

[Required] Gets the name of this CreateBucketDetails. 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: Example: my-new-bucket1

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

property object_events_enabled¶

Gets the object_events_enabled of this CreateBucketDetails. 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 CreateBucketDetails.
Return type: bool

property public_access_type¶

Gets the public_access_type of this CreateBucketDetails. 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 CreateBucketDetails.
Return type: str

property storage_tier¶

Gets the storage_tier of this CreateBucketDetails. 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.

Allowed values for this property are: “Standard”, “Archive”

Returns: The storage_tier of this CreateBucketDetails.
Return type: str

property versioning¶

Gets the versioning of this CreateBucketDetails. Set the versioning status on the bucket. By default, a bucket is created with versioning Disabled. Use this option to enable versioning during bucket creation. Objects in a version enabled bucket are protected from overwrites and deletions. Previous versions of the same object will be available in the bucket.

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

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