CreateVolumeGroupDetails¶

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

Bases: object

CreateVolumeGroupDetails model.

Methods

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

Attributes

`availability_domain`	[Required] Gets the availability_domain of this CreateVolumeGroupDetails.
`backup_policy_id`	Gets the backup_policy_id of this CreateVolumeGroupDetails.
`cluster_placement_group_id`	Gets the cluster_placement_group_id of this CreateVolumeGroupDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateVolumeGroupDetails.
`defined_tags`	Gets the defined_tags of this CreateVolumeGroupDetails.
`display_name`	Gets the display_name of this CreateVolumeGroupDetails.
`freeform_tags`	Gets the freeform_tags of this CreateVolumeGroupDetails.
`source_details`	[Required] Gets the source_details of this CreateVolumeGroupDetails.
`volume_group_replicas`	Gets the volume_group_replicas of this CreateVolumeGroupDetails.
`xrc_kms_key_id`	Gets the xrc_kms_key_id of this CreateVolumeGroupDetails.

__init__(**kwargs)¶

Initializes a new CreateVolumeGroupDetails 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 CreateVolumeGroupDetails.
backup_policy_id (str) – The value to assign to the backup_policy_id property of this CreateVolumeGroupDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateVolumeGroupDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateVolumeGroupDetails.
display_name (str) – The value to assign to the display_name property of this CreateVolumeGroupDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateVolumeGroupDetails.
source_details (oci.core.models.VolumeGroupSourceDetails) – The value to assign to the source_details property of this CreateVolumeGroupDetails.
volume_group_replicas (list[oci.core.models.VolumeGroupReplicaDetails]) – The value to assign to the volume_group_replicas property of this CreateVolumeGroupDetails.
cluster_placement_group_id (str) – The value to assign to the cluster_placement_group_id property of this CreateVolumeGroupDetails.
xrc_kms_key_id (str) – The value to assign to the xrc_kms_key_id property of this CreateVolumeGroupDetails.

availability_domain¶

[Required] Gets the availability_domain of this CreateVolumeGroupDetails. The availability domain of the volume group.

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

backup_policy_id¶

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

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

cluster_placement_group_id¶

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

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

compartment_id¶

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

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

defined_tags¶

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

display_name¶

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

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

freeform_tags¶

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

source_details¶

[Required] Gets the source_details of this CreateVolumeGroupDetails.

Returns:	The source_details of this CreateVolumeGroupDetails.
Return type:	oci.core.models.VolumeGroupSourceDetails

volume_group_replicas¶

Gets the volume_group_replicas of this CreateVolumeGroupDetails. The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.

Returns:	The volume_group_replicas of this CreateVolumeGroupDetails.
Return type:	list[oci.core.models.VolumeGroupReplicaDetails]

xrc_kms_key_id¶

Gets the xrc_kms_key_id of this CreateVolumeGroupDetails. The OCID of the Vault service key which is the master encryption key for the volume’s 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 CreateVolumeGroupDetails.
Return type:	str