CreateVolumeDetails¶

class oci.core.models.CreateVolumeDetails(**kwargs)¶

Bases: object

The details of the volume to create. For CreateVolume operation, this field is required in the request, see create_volume().

Methods

__init__(**kwargs) Initializes a new CreateVolumeDetails object with values from keyword arguments.

Attributes

`autotune_policies`	Gets the autotune_policies of this CreateVolumeDetails.
`availability_domain`	Gets the availability_domain of this CreateVolumeDetails.
`backup_policy_id`	Gets the backup_policy_id of this CreateVolumeDetails.
`block_volume_replicas`	Gets the block_volume_replicas of this CreateVolumeDetails.
`cluster_placement_group_id`	Gets the cluster_placement_group_id of this CreateVolumeDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateVolumeDetails.
`defined_tags`	Gets the defined_tags of this CreateVolumeDetails.
`display_name`	Gets the display_name of this CreateVolumeDetails.
`freeform_tags`	Gets the freeform_tags of this CreateVolumeDetails.
`is_auto_tune_enabled`	Gets the is_auto_tune_enabled of this CreateVolumeDetails.
`kms_key_id`	Gets the kms_key_id of this CreateVolumeDetails.
`size_in_gbs`	Gets the size_in_gbs of this CreateVolumeDetails.
`size_in_mbs`	Gets the size_in_mbs of this CreateVolumeDetails.
`source_details`	Gets the source_details of this CreateVolumeDetails.
`volume_backup_id`	Gets the volume_backup_id of this CreateVolumeDetails.
`vpus_per_gb`	Gets the vpus_per_gb of this CreateVolumeDetails.
`xrc_kms_key_id`	Gets the xrc_kms_key_id of this CreateVolumeDetails.

__init__(**kwargs)¶

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

Parameters:

availability_domain (str) – The value to assign to the availability_domain property of this CreateVolumeDetails.
backup_policy_id (str) – The value to assign to the backup_policy_id property of this CreateVolumeDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateVolumeDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateVolumeDetails.
display_name (str) – The value to assign to the display_name property of this CreateVolumeDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateVolumeDetails.
kms_key_id (str) – The value to assign to the kms_key_id property of this CreateVolumeDetails.
vpus_per_gb (int) – The value to assign to the vpus_per_gb property of this CreateVolumeDetails.
cluster_placement_group_id (str) – The value to assign to the cluster_placement_group_id property of this CreateVolumeDetails.
size_in_gbs (int) – The value to assign to the size_in_gbs property of this CreateVolumeDetails.
size_in_mbs (int) – The value to assign to the size_in_mbs property of this CreateVolumeDetails.
source_details (oci.core.models.VolumeSourceDetails) – The value to assign to the source_details property of this CreateVolumeDetails.
volume_backup_id (str) – The value to assign to the volume_backup_id property of this CreateVolumeDetails.
is_auto_tune_enabled (bool) – The value to assign to the is_auto_tune_enabled property of this CreateVolumeDetails.
block_volume_replicas (list[oci.core.models.BlockVolumeReplicaDetails]) – The value to assign to the block_volume_replicas property of this CreateVolumeDetails.
autotune_policies (list[oci.core.models.AutotunePolicy]) – The value to assign to the autotune_policies property of this CreateVolumeDetails.
xrc_kms_key_id (str) – The value to assign to the xrc_kms_key_id property of this CreateVolumeDetails.

autotune_policies¶

Gets the autotune_policies of this CreateVolumeDetails. The list of autotune policies to be enabled for this volume.

Returns:	The autotune_policies of this CreateVolumeDetails.
Return type:	list[oci.core.models.AutotunePolicy]

availability_domain¶

Gets the availability_domain of this CreateVolumeDetails. 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: Uocm:PHX-AD-1

Returns:	The availability_domain of this CreateVolumeDetails.
Return type:	str

backup_policy_id¶

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

Returns:	The backup_policy_id of this CreateVolumeDetails.
Return type:	str

block_volume_replicas¶

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

Returns:	The block_volume_replicas of this CreateVolumeDetails.
Return type:	list[oci.core.models.BlockVolumeReplicaDetails]

cluster_placement_group_id¶

Gets the cluster_placement_group_id of this CreateVolumeDetails. The clusterPlacementGroup Id of the volume for volume placement.

Returns:	The cluster_placement_group_id of this CreateVolumeDetails.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this CreateVolumeDetails. The OCID of the compartment that contains the volume.

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

defined_tags¶

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

display_name¶

Gets the display_name of this CreateVolumeDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this CreateVolumeDetails.
Return type:	str

freeform_tags¶

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

is_auto_tune_enabled¶

Gets the is_auto_tune_enabled of this CreateVolumeDetails. Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for detached autotune.

Returns:	The is_auto_tune_enabled of this CreateVolumeDetails.
Return type:	bool

kms_key_id¶

Gets the kms_key_id of this CreateVolumeDetails. The OCID of the Vault service key to assign as the master encryption key for the volume.

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

size_in_gbs¶

Gets the size_in_gbs of this CreateVolumeDetails. The size of the volume in GBs.

Returns:	The size_in_gbs of this CreateVolumeDetails.
Return type:	int

size_in_mbs¶

Gets the size_in_mbs of this CreateVolumeDetails. The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.

Returns:	The size_in_mbs of this CreateVolumeDetails.
Return type:	int

source_details¶

Gets the source_details of this CreateVolumeDetails.

Returns:	The source_details of this CreateVolumeDetails.
Return type:	oci.core.models.VolumeSourceDetails

volume_backup_id¶

Gets the volume_backup_id of this CreateVolumeDetails. 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.

Returns:	The volume_backup_id of this CreateVolumeDetails.
Return type:	str

vpus_per_gb¶

Gets the vpus_per_gb of this CreateVolumeDetails. 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:

0: Represents Lower Cost option.

10: Represents Balanced option.

20: Represents Higher Performance option.

30-120: Represents the Ultra High Performance option.

For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.

Returns:	The vpus_per_gb of this CreateVolumeDetails.
Return type:	int

xrc_kms_key_id¶

Gets the xrc_kms_key_id of this CreateVolumeDetails. The OCID of the Vault service key which is the master encryption key for the block volume cross region backups, which will be used in the destination region to encrypt the backup’s encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.

Returns:	The xrc_kms_key_id of this CreateVolumeDetails.
Return type:	str