Class CreateBucketDetails

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.

Inheritance

object

CreateBucketDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ObjectstorageService.Models

Assembly: OCI.DotNetSDK.Objectstorage.dll

Syntax

public class CreateBucketDetails

Properties

AutoTiering

Declaration

[JsonProperty(PropertyName = "autoTiering")]
[JsonConverter(typeof(StringEnumConverter))]
public Bucket.AutoTieringEnum? AutoTiering { get; set; }

Property Value

Type	Description
Bucket.AutoTieringEnum?	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.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The ID of the compartment in which to create the bucket.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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"}

KmsKeyId

Declaration

[JsonProperty(PropertyName = "kmsKeyId")]
public string KmsKeyId { get; set; }

Property Value

Type	Description
string	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.

Metadata

Declaration

[JsonProperty(PropertyName = "metadata")]
public Dictionary<string, string> Metadata { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Arbitrary string, up to 4KB, of keys and values for user-defined metadata.

Name

Declaration

[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }

Property Value

Type	Description
string	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:

Remarks

Required

ObjectEventsEnabled

Declaration

[JsonProperty(PropertyName = "objectEventsEnabled")]
public bool? ObjectEventsEnabled { get; set; }

Property Value

Type	Description
bool?	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.

PublicAccessType

Declaration

[JsonProperty(PropertyName = "publicAccessType")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateBucketDetails.PublicAccessTypeEnum? PublicAccessType { get; set; }

Property Value

Type Description

Type	Description
CreateBucketDetails.PublicAccessTypeEnum?	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.

CreateBucketDetails.PublicAccessTypeEnum?

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.

StorageTier

Declaration

[JsonProperty(PropertyName = "storageTier")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateBucketDetails.StorageTierEnum? StorageTier { get; set; }

Property Value

Type	Description
CreateBucketDetails.StorageTierEnum?	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.

Versioning

Declaration

[JsonProperty(PropertyName = "versioning")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateBucketDetails.VersioningEnum? Versioning { get; set; }

Property Value

Type	Description
CreateBucketDetails.VersioningEnum?	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.