File: //lib/mysqlsh/lib/python3.8/site-packages/oci/core/models/create_boot_volume_details.py
# coding: utf-8
# Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20160918
from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401
from oci.decorators import init_model_state_from_kwargs
@init_model_state_from_kwargs
class CreateBootVolumeDetails(object):
"""
CreateBootVolumeDetails model.
"""
def __init__(self, **kwargs):
"""
Initializes a new CreateBootVolumeDetails object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param availability_domain:
The value to assign to the availability_domain property of this CreateBootVolumeDetails.
:type availability_domain: str
:param backup_policy_id:
The value to assign to the backup_policy_id property of this CreateBootVolumeDetails.
:type backup_policy_id: str
:param compartment_id:
The value to assign to the compartment_id property of this CreateBootVolumeDetails.
:type compartment_id: str
:param defined_tags:
The value to assign to the defined_tags property of this CreateBootVolumeDetails.
:type defined_tags: dict(str, dict(str, object))
:param display_name:
The value to assign to the display_name property of this CreateBootVolumeDetails.
:type display_name: str
:param freeform_tags:
The value to assign to the freeform_tags property of this CreateBootVolumeDetails.
:type freeform_tags: dict(str, str)
:param kms_key_id:
The value to assign to the kms_key_id property of this CreateBootVolumeDetails.
:type kms_key_id: str
:param size_in_gbs:
The value to assign to the size_in_gbs property of this CreateBootVolumeDetails.
:type size_in_gbs: int
:param cluster_placement_group_id:
The value to assign to the cluster_placement_group_id property of this CreateBootVolumeDetails.
:type cluster_placement_group_id: str
:param vpus_per_gb:
The value to assign to the vpus_per_gb property of this CreateBootVolumeDetails.
:type vpus_per_gb: int
:param source_details:
The value to assign to the source_details property of this CreateBootVolumeDetails.
:type source_details: oci.core.models.BootVolumeSourceDetails
:param is_auto_tune_enabled:
The value to assign to the is_auto_tune_enabled property of this CreateBootVolumeDetails.
:type is_auto_tune_enabled: bool
:param boot_volume_replicas:
The value to assign to the boot_volume_replicas property of this CreateBootVolumeDetails.
:type boot_volume_replicas: list[oci.core.models.BootVolumeReplicaDetails]
:param autotune_policies:
The value to assign to the autotune_policies property of this CreateBootVolumeDetails.
:type autotune_policies: list[oci.core.models.AutotunePolicy]
:param xrc_kms_key_id:
The value to assign to the xrc_kms_key_id property of this CreateBootVolumeDetails.
:type xrc_kms_key_id: str
"""
self.swagger_types = {
'availability_domain': 'str',
'backup_policy_id': 'str',
'compartment_id': 'str',
'defined_tags': 'dict(str, dict(str, object))',
'display_name': 'str',
'freeform_tags': 'dict(str, str)',
'kms_key_id': 'str',
'size_in_gbs': 'int',
'cluster_placement_group_id': 'str',
'vpus_per_gb': 'int',
'source_details': 'BootVolumeSourceDetails',
'is_auto_tune_enabled': 'bool',
'boot_volume_replicas': 'list[BootVolumeReplicaDetails]',
'autotune_policies': 'list[AutotunePolicy]',
'xrc_kms_key_id': 'str'
}
self.attribute_map = {
'availability_domain': 'availabilityDomain',
'backup_policy_id': 'backupPolicyId',
'compartment_id': 'compartmentId',
'defined_tags': 'definedTags',
'display_name': 'displayName',
'freeform_tags': 'freeformTags',
'kms_key_id': 'kmsKeyId',
'size_in_gbs': 'sizeInGBs',
'cluster_placement_group_id': 'clusterPlacementGroupId',
'vpus_per_gb': 'vpusPerGB',
'source_details': 'sourceDetails',
'is_auto_tune_enabled': 'isAutoTuneEnabled',
'boot_volume_replicas': 'bootVolumeReplicas',
'autotune_policies': 'autotunePolicies',
'xrc_kms_key_id': 'xrcKmsKeyId'
}
self._availability_domain = None
self._backup_policy_id = None
self._compartment_id = None
self._defined_tags = None
self._display_name = None
self._freeform_tags = None
self._kms_key_id = None
self._size_in_gbs = None
self._cluster_placement_group_id = None
self._vpus_per_gb = None
self._source_details = None
self._is_auto_tune_enabled = None
self._boot_volume_replicas = None
self._autotune_policies = None
self._xrc_kms_key_id = None
@property
def availability_domain(self):
"""
Gets the availability_domain of this CreateBootVolumeDetails.
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`
:return: The availability_domain of this CreateBootVolumeDetails.
:rtype: str
"""
return self._availability_domain
@availability_domain.setter
def availability_domain(self, availability_domain):
"""
Sets the availability_domain of this CreateBootVolumeDetails.
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`
:param availability_domain: The availability_domain of this CreateBootVolumeDetails.
:type: str
"""
self._availability_domain = availability_domain
@property
def backup_policy_id(self):
"""
Gets the backup_policy_id of this CreateBootVolumeDetails.
If provided, specifies the ID of the boot volume backup policy to assign to the newly
created boot volume. If omitted, no policy will be assigned.
:return: The backup_policy_id of this CreateBootVolumeDetails.
:rtype: str
"""
return self._backup_policy_id
@backup_policy_id.setter
def backup_policy_id(self, backup_policy_id):
"""
Sets the backup_policy_id of this CreateBootVolumeDetails.
If provided, specifies the ID of the boot volume backup policy to assign to the newly
created boot volume. If omitted, no policy will be assigned.
:param backup_policy_id: The backup_policy_id of this CreateBootVolumeDetails.
:type: str
"""
self._backup_policy_id = backup_policy_id
@property
def compartment_id(self):
"""
**[Required]** Gets the compartment_id of this CreateBootVolumeDetails.
The OCID of the compartment that contains the boot volume.
:return: The compartment_id of this CreateBootVolumeDetails.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this CreateBootVolumeDetails.
The OCID of the compartment that contains the boot volume.
:param compartment_id: The compartment_id of this CreateBootVolumeDetails.
:type: str
"""
self._compartment_id = compartment_id
@property
def defined_tags(self):
"""
Gets the defined_tags of this CreateBootVolumeDetails.
Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see `Resource Tags`__.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
:return: The defined_tags of this CreateBootVolumeDetails.
:rtype: dict(str, dict(str, object))
"""
return self._defined_tags
@defined_tags.setter
def defined_tags(self, defined_tags):
"""
Sets the defined_tags of this CreateBootVolumeDetails.
Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see `Resource Tags`__.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
:param defined_tags: The defined_tags of this CreateBootVolumeDetails.
:type: dict(str, dict(str, object))
"""
self._defined_tags = defined_tags
@property
def display_name(self):
"""
Gets the display_name of this CreateBootVolumeDetails.
A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
:return: The display_name of this CreateBootVolumeDetails.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this CreateBootVolumeDetails.
A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
:param display_name: The display_name of this CreateBootVolumeDetails.
:type: str
"""
self._display_name = display_name
@property
def freeform_tags(self):
"""
Gets the freeform_tags of this CreateBootVolumeDetails.
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\"}`
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
:return: The freeform_tags of this CreateBootVolumeDetails.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets the freeform_tags of this CreateBootVolumeDetails.
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\"}`
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
:param freeform_tags: The freeform_tags of this CreateBootVolumeDetails.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def kms_key_id(self):
"""
Gets the kms_key_id of this CreateBootVolumeDetails.
The OCID of the Vault service key to assign as the master encryption key
for the boot volume.
:return: The kms_key_id of this CreateBootVolumeDetails.
:rtype: str
"""
return self._kms_key_id
@kms_key_id.setter
def kms_key_id(self, kms_key_id):
"""
Sets the kms_key_id of this CreateBootVolumeDetails.
The OCID of the Vault service key to assign as the master encryption key
for the boot volume.
:param kms_key_id: The kms_key_id of this CreateBootVolumeDetails.
:type: str
"""
self._kms_key_id = kms_key_id
@property
def size_in_gbs(self):
"""
Gets the size_in_gbs of this CreateBootVolumeDetails.
The size of the volume in GBs.
:return: The size_in_gbs of this CreateBootVolumeDetails.
:rtype: int
"""
return self._size_in_gbs
@size_in_gbs.setter
def size_in_gbs(self, size_in_gbs):
"""
Sets the size_in_gbs of this CreateBootVolumeDetails.
The size of the volume in GBs.
:param size_in_gbs: The size_in_gbs of this CreateBootVolumeDetails.
:type: int
"""
self._size_in_gbs = size_in_gbs
@property
def cluster_placement_group_id(self):
"""
Gets the cluster_placement_group_id of this CreateBootVolumeDetails.
The clusterPlacementGroup Id of the volume for volume placement.
:return: The cluster_placement_group_id of this CreateBootVolumeDetails.
:rtype: str
"""
return self._cluster_placement_group_id
@cluster_placement_group_id.setter
def cluster_placement_group_id(self, cluster_placement_group_id):
"""
Sets the cluster_placement_group_id of this CreateBootVolumeDetails.
The clusterPlacementGroup Id of the volume for volume placement.
:param cluster_placement_group_id: The cluster_placement_group_id of this CreateBootVolumeDetails.
:type: str
"""
self._cluster_placement_group_id = cluster_placement_group_id
@property
def vpus_per_gb(self):
"""
Gets the vpus_per_gb of this CreateBootVolumeDetails.
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:
* `10`: Represents the Balanced option.
* `20`: Represents the Higher Performance option.
* `30`-`120`: Represents the Ultra High Performance option.
For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.
__ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels
:return: The vpus_per_gb of this CreateBootVolumeDetails.
:rtype: int
"""
return self._vpus_per_gb
@vpus_per_gb.setter
def vpus_per_gb(self, vpus_per_gb):
"""
Sets the vpus_per_gb of this CreateBootVolumeDetails.
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:
* `10`: Represents the Balanced option.
* `20`: Represents the Higher Performance option.
* `30`-`120`: Represents the Ultra High Performance option.
For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.
__ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels
:param vpus_per_gb: The vpus_per_gb of this CreateBootVolumeDetails.
:type: int
"""
self._vpus_per_gb = vpus_per_gb
@property
def source_details(self):
"""
**[Required]** Gets the source_details of this CreateBootVolumeDetails.
:return: The source_details of this CreateBootVolumeDetails.
:rtype: oci.core.models.BootVolumeSourceDetails
"""
return self._source_details
@source_details.setter
def source_details(self, source_details):
"""
Sets the source_details of this CreateBootVolumeDetails.
:param source_details: The source_details of this CreateBootVolumeDetails.
:type: oci.core.models.BootVolumeSourceDetails
"""
self._source_details = source_details
@property
def is_auto_tune_enabled(self):
"""
Gets the is_auto_tune_enabled of this CreateBootVolumeDetails.
Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated.
Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune.
:return: The is_auto_tune_enabled of this CreateBootVolumeDetails.
:rtype: bool
"""
return self._is_auto_tune_enabled
@is_auto_tune_enabled.setter
def is_auto_tune_enabled(self, is_auto_tune_enabled):
"""
Sets the is_auto_tune_enabled of this CreateBootVolumeDetails.
Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated.
Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune.
:param is_auto_tune_enabled: The is_auto_tune_enabled of this CreateBootVolumeDetails.
:type: bool
"""
self._is_auto_tune_enabled = is_auto_tune_enabled
@property
def boot_volume_replicas(self):
"""
Gets the boot_volume_replicas of this CreateBootVolumeDetails.
The list of boot volume replicas to be enabled for this boot volume
in the specified destination availability domains.
:return: The boot_volume_replicas of this CreateBootVolumeDetails.
:rtype: list[oci.core.models.BootVolumeReplicaDetails]
"""
return self._boot_volume_replicas
@boot_volume_replicas.setter
def boot_volume_replicas(self, boot_volume_replicas):
"""
Sets the boot_volume_replicas of this CreateBootVolumeDetails.
The list of boot volume replicas to be enabled for this boot volume
in the specified destination availability domains.
:param boot_volume_replicas: The boot_volume_replicas of this CreateBootVolumeDetails.
:type: list[oci.core.models.BootVolumeReplicaDetails]
"""
self._boot_volume_replicas = boot_volume_replicas
@property
def autotune_policies(self):
"""
Gets the autotune_policies of this CreateBootVolumeDetails.
The list of autotune policies to be enabled for this volume.
:return: The autotune_policies of this CreateBootVolumeDetails.
:rtype: list[oci.core.models.AutotunePolicy]
"""
return self._autotune_policies
@autotune_policies.setter
def autotune_policies(self, autotune_policies):
"""
Sets the autotune_policies of this CreateBootVolumeDetails.
The list of autotune policies to be enabled for this volume.
:param autotune_policies: The autotune_policies of this CreateBootVolumeDetails.
:type: list[oci.core.models.AutotunePolicy]
"""
self._autotune_policies = autotune_policies
@property
def xrc_kms_key_id(self):
"""
Gets the xrc_kms_key_id of this CreateBootVolumeDetails.
The OCID of the Vault service key which is the master encryption key for the boot 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`__.
__ https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm
__ https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm
:return: The xrc_kms_key_id of this CreateBootVolumeDetails.
:rtype: str
"""
return self._xrc_kms_key_id
@xrc_kms_key_id.setter
def xrc_kms_key_id(self, xrc_kms_key_id):
"""
Sets the xrc_kms_key_id of this CreateBootVolumeDetails.
The OCID of the Vault service key which is the master encryption key for the boot 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`__.
__ https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm
__ https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm
:param xrc_kms_key_id: The xrc_kms_key_id of this CreateBootVolumeDetails.
:type: str
"""
self._xrc_kms_key_id = xrc_kms_key_id
def __repr__(self):
return formatted_flat_dict(self)
def __eq__(self, other):
if other is None:
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
return not self == other