Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateVolumeDetails

The details of the volume to create. For CreateVolume operation, this field is required in the request, see {@link #createVolume(CreateVolumeRequest) createVolume}.

Properties

Functions

Properties

Optional autotunePolicies

autotunePolicies: Array<AutotunePolicy>

The list of autotune policies to be enabled for this volume.

Optional availabilityDomain

availabilityDomain: undefined | string

The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume.

Example: {@code Uocm:PHX-AD-1}

Optional backupPolicyId

backupPolicyId: undefined | string

If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned.

Optional blockVolumeReplicas

blockVolumeReplicas: Array<BlockVolumeReplicaDetails>

The list of block volume replicas to be enabled for this volume in the specified destination availability domains.

Optional clusterPlacementGroupId

clusterPlacementGroupId: undefined | string

The clusterPlacementGroup Id of the volume for volume placement.

compartmentId

compartmentId: string

The OCID of the compartment that contains the volume.

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 displayName

displayName: undefined | string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

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 isAutoTuneEnabled

isAutoTuneEnabled: undefined | false | true

Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. Use the {@code DetachedVolumeAutotunePolicy} instead to enable the volume for detached autotune.

Optional kmsKeyId

kmsKeyId: undefined | string

The OCID of the Vault service key to assign as the master encryption key for the volume.

Optional sizeInGBs

sizeInGBs: undefined | number

The size of the volume in GBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional sizeInMBs

sizeInMBs: undefined | number

The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional sourceDetails

sourceDetails: VolumeSourceFromBlockVolumeReplicaDetails | VolumeSourceFromVolumeDetails | VolumeSourceFromVolumeBackupDetails

Optional volumeBackupId

volumeBackupId: undefined | string

The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.

Optional vpusPerGB

vpusPerGB: undefined | number

The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

Allowed values:

{@code 0}: Represents Lower Cost option.

{@code 10}: Represents Balanced option.

{@code 20}: Represents Higher Performance option.

{@code 30}-{@code 120}: Represents the Ultra High Performance option.

For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

getJsonObj