Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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.

Properties

Optional autoTiering

autoTiering: undefined | string

Set the auto tiering status on the bucket. By default, a bucket is created with auto tiering {@code Disabled}. Use this option to enable auto tiering during bucket creation. Objects in a bucket with auto tiering set to {@code InfrequentAccess} are transitioned automatically between the 'Standard' and 'InfrequentAccess' tiers based on the access pattern of the objects.

compartmentId

compartmentId: string

The ID of the compartment in which to create the bucket.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional freeformTags

freeformTags: undefined | object

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: {@code {"Department": "Finance"}}

Optional kmsKeyId

kmsKeyId: undefined | 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.

Optional metadata

metadata: undefined | object

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

name

name: 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: Example: my-new-bucket1

Optional objectEventsEnabled

objectEventsEnabled: undefined | false | true

Whether or not events are emitted for object state changes in this bucket. By default, {@code objectEventsEnabled} is set to {@code false}. Set {@code objectEventsEnabled} to {@code true} to emit events for object state changes. For more information about events, see Overview of Events.

Optional publicAccessType

publicAccessType: PublicAccessType

The type of public access enabled on this bucket. A bucket is set to {@code NoPublicAccess} by default, which only allows an authenticated caller to access the bucket and its contents. When {@code ObjectRead} is enabled on the bucket, public access is allowed for the {@code GetObject}, {@code HeadObject}, and {@code ListObjects} operations. When {@code ObjectReadWithoutList} is enabled on the bucket, public access is allowed for the {@code GetObject} and {@code HeadObject} operations.

Optional storageTier

storageTier: StorageTier

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.

Optional versioning

versioning: Versioning

Set the versioning status on the bucket. By default, a bucket is created with versioning {@code 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.

Functions

getDeserializedJsonObj

getJsonObj