CreateDesktopPoolDetails

class oci.desktops.models.CreateDesktopPoolDetails(**kwargs)

Bases: object

Provides the configuration information used to create the desktop pool.

Attributes:

USE_DEDICATED_VM_HOST_AUTO

A constant which can be used with the use_dedicated_vm_host property of a CreateDesktopPoolDetails.

USE_DEDICATED_VM_HOST_FALSE

A constant which can be used with the use_dedicated_vm_host property of a CreateDesktopPoolDetails.

USE_DEDICATED_VM_HOST_TRUE

A constant which can be used with the use_dedicated_vm_host property of a CreateDesktopPoolDetails.

are_privileged_users

[Required] Gets the are_privileged_users of this CreateDesktopPoolDetails.

availability_domain

[Required] Gets the availability_domain of this CreateDesktopPoolDetails.

availability_policy

[Required] Gets the availability_policy of this CreateDesktopPoolDetails.

boot_volume_size_in_gbs

Gets the boot_volume_size_in_gbs of this CreateDesktopPoolDetails.

compartment_id

[Required] Gets the compartment_id of this CreateDesktopPoolDetails.

contact_details

[Required] Gets the contact_details of this CreateDesktopPoolDetails.

defined_tags

Gets the defined_tags of this CreateDesktopPoolDetails.

description

Gets the description of this CreateDesktopPoolDetails.

device_policy

[Required] Gets the device_policy of this CreateDesktopPoolDetails.

display_name

[Required] Gets the display_name of this CreateDesktopPoolDetails.

freeform_tags

Gets the freeform_tags of this CreateDesktopPoolDetails.

image

[Required] Gets the image of this CreateDesktopPoolDetails.

is_storage_enabled

[Required] Gets the is_storage_enabled of this CreateDesktopPoolDetails.

maximum_size

[Required] Gets the maximum_size of this CreateDesktopPoolDetails.

network_configuration

[Required] Gets the network_configuration of this CreateDesktopPoolDetails.

nsg_ids

Gets the nsg_ids of this CreateDesktopPoolDetails.

private_access_details

Gets the private_access_details of this CreateDesktopPoolDetails.

security_attributes

Gets the security_attributes of this CreateDesktopPoolDetails.

session_lifecycle_actions

Gets the session_lifecycle_actions of this CreateDesktopPoolDetails.

shape_config

Gets the shape_config of this CreateDesktopPoolDetails.

shape_name

[Required] Gets the shape_name of this CreateDesktopPoolDetails.

standby_size

[Required] Gets the standby_size of this CreateDesktopPoolDetails.

storage_backup_policy_id

[Required] Gets the storage_backup_policy_id of this CreateDesktopPoolDetails.

storage_size_in_gbs

[Required] Gets the storage_size_in_gbs of this CreateDesktopPoolDetails.

time_start_scheduled

Gets the time_start_scheduled of this CreateDesktopPoolDetails.

time_stop_scheduled

Gets the time_stop_scheduled of this CreateDesktopPoolDetails.

use_dedicated_vm_host

Gets the use_dedicated_vm_host of this CreateDesktopPoolDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateDesktopPoolDetails object with values from keyword arguments.

USE_DEDICATED_VM_HOST_AUTO = 'AUTO'

A constant which can be used with the use_dedicated_vm_host property of a CreateDesktopPoolDetails. This constant has a value of “AUTO”

USE_DEDICATED_VM_HOST_FALSE = 'FALSE'

A constant which can be used with the use_dedicated_vm_host property of a CreateDesktopPoolDetails. This constant has a value of “FALSE”

USE_DEDICATED_VM_HOST_TRUE = 'TRUE'

A constant which can be used with the use_dedicated_vm_host property of a CreateDesktopPoolDetails. This constant has a value of “TRUE”

__init__(**kwargs)

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

Parameters
  • compartment_id (str) – The value to assign to the compartment_id property of this CreateDesktopPoolDetails.

  • display_name (str) – The value to assign to the display_name property of this CreateDesktopPoolDetails.

  • description (str) – The value to assign to the description property of this CreateDesktopPoolDetails.

  • maximum_size (int) – The value to assign to the maximum_size property of this CreateDesktopPoolDetails.

  • standby_size (int) – The value to assign to the standby_size property of this CreateDesktopPoolDetails.

  • shape_name (str) – The value to assign to the shape_name property of this CreateDesktopPoolDetails.

  • shape_config (oci.desktops.models.CreateDesktopPoolShapeConfigDetails) – The value to assign to the shape_config property of this CreateDesktopPoolDetails.

  • use_dedicated_vm_host (str) – The value to assign to the use_dedicated_vm_host property of this CreateDesktopPoolDetails. Allowed values for this property are: “TRUE”, “FALSE”, “AUTO”

  • is_storage_enabled (bool) – The value to assign to the is_storage_enabled property of this CreateDesktopPoolDetails.

  • storage_size_in_gbs (int) – The value to assign to the storage_size_in_gbs property of this CreateDesktopPoolDetails.

  • storage_backup_policy_id (str) – The value to assign to the storage_backup_policy_id property of this CreateDesktopPoolDetails.

  • device_policy (oci.desktops.models.DesktopDevicePolicy) – The value to assign to the device_policy property of this CreateDesktopPoolDetails.

  • availability_policy (oci.desktops.models.DesktopAvailabilityPolicy) – The value to assign to the availability_policy property of this CreateDesktopPoolDetails.

  • image (oci.desktops.models.DesktopImage) – The value to assign to the image property of this CreateDesktopPoolDetails.

  • network_configuration (oci.desktops.models.DesktopNetworkConfiguration) – The value to assign to the network_configuration property of this CreateDesktopPoolDetails.

  • session_lifecycle_actions (oci.desktops.models.CreateDesktopPoolDesktopSessionLifecycleActions) – The value to assign to the session_lifecycle_actions property of this CreateDesktopPoolDetails.

  • time_start_scheduled (datetime) – The value to assign to the time_start_scheduled property of this CreateDesktopPoolDetails.

  • time_stop_scheduled (datetime) – The value to assign to the time_stop_scheduled property of this CreateDesktopPoolDetails.

  • contact_details (str) – The value to assign to the contact_details property of this CreateDesktopPoolDetails.

  • are_privileged_users (bool) – The value to assign to the are_privileged_users property of this CreateDesktopPoolDetails.

  • availability_domain (str) – The value to assign to the availability_domain property of this CreateDesktopPoolDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDesktopPoolDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDesktopPoolDetails.

  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateDesktopPoolDetails.

  • private_access_details (oci.desktops.models.CreateDesktopPoolPrivateAccessDetails) – The value to assign to the private_access_details property of this CreateDesktopPoolDetails.

  • security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this CreateDesktopPoolDetails.

  • boot_volume_size_in_gbs (int) – The value to assign to the boot_volume_size_in_gbs property of this CreateDesktopPoolDetails.

property are_privileged_users

[Required] Gets the are_privileged_users of this CreateDesktopPoolDetails. Indicates whether desktop pool users have administrative privileges on their desktop.

Returns

The are_privileged_users of this CreateDesktopPoolDetails.

Return type

bool

property availability_domain

[Required] Gets the availability_domain of this CreateDesktopPoolDetails. The availability domain of the desktop pool.

Returns

The availability_domain of this CreateDesktopPoolDetails.

Return type

str

property availability_policy

[Required] Gets the availability_policy of this CreateDesktopPoolDetails.

Returns

The availability_policy of this CreateDesktopPoolDetails.

Return type

oci.desktops.models.DesktopAvailabilityPolicy

property boot_volume_size_in_gbs

Gets the boot_volume_size_in_gbs of this CreateDesktopPoolDetails. The size in GBs of the boot volume for the desktop pool.

Returns

The boot_volume_size_in_gbs of this CreateDesktopPoolDetails.

Return type

int

property compartment_id

[Required] Gets the compartment_id of this CreateDesktopPoolDetails. The OCID of the compartment which will contain the desktop pool.

Returns

The compartment_id of this CreateDesktopPoolDetails.

Return type

str

property contact_details

[Required] Gets the contact_details of this CreateDesktopPoolDetails. Contact information of the desktop pool administrator. Avoid entering confidential information.

Returns

The contact_details of this CreateDesktopPoolDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateDesktopPoolDetails. 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 CreateDesktopPoolDetails.

Return type

dict(str, dict(str, object))

property description

Gets the description of this CreateDesktopPoolDetails. A user friendly description providing additional information about the resource. Avoid entering confidential information.

Returns

The description of this CreateDesktopPoolDetails.

Return type

str

property device_policy

[Required] Gets the device_policy of this CreateDesktopPoolDetails.

Returns

The device_policy of this CreateDesktopPoolDetails.

Return type

oci.desktops.models.DesktopDevicePolicy

property display_name

[Required] Gets the display_name of this CreateDesktopPoolDetails. A user friendly display name. Avoid entering confidential information.

Returns

The display_name of this CreateDesktopPoolDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateDesktopPoolDetails. 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 CreateDesktopPoolDetails.

Return type

dict(str, str)

property image

[Required] Gets the image of this CreateDesktopPoolDetails.

Returns

The image of this CreateDesktopPoolDetails.

Return type

oci.desktops.models.DesktopImage

property is_storage_enabled

[Required] Gets the is_storage_enabled of this CreateDesktopPoolDetails. Indicates whether storage is enabled for the desktop pool.

Returns

The is_storage_enabled of this CreateDesktopPoolDetails.

Return type

bool

property maximum_size

[Required] Gets the maximum_size of this CreateDesktopPoolDetails. The maximum number of desktops permitted in the desktop pool.

Returns

The maximum_size of this CreateDesktopPoolDetails.

Return type

int

property network_configuration

[Required] Gets the network_configuration of this CreateDesktopPoolDetails.

Returns

The network_configuration of this CreateDesktopPoolDetails.

Return type

oci.desktops.models.DesktopNetworkConfiguration

property nsg_ids

Gets the nsg_ids of this CreateDesktopPoolDetails. A list of network security groups for the private access.

Returns

The nsg_ids of this CreateDesktopPoolDetails.

Return type

list[str]

property private_access_details

Gets the private_access_details of this CreateDesktopPoolDetails.

Returns

The private_access_details of this CreateDesktopPoolDetails.

Return type

oci.desktops.models.CreateDesktopPoolPrivateAccessDetails

property security_attributes

Gets the security_attributes of this CreateDesktopPoolDetails. Security attributes for this resource. Each attribute can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources.

Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “audit”}}}

Returns

The security_attributes of this CreateDesktopPoolDetails.

Return type

dict(str, dict(str, object))

property session_lifecycle_actions

Gets the session_lifecycle_actions of this CreateDesktopPoolDetails.

Returns

The session_lifecycle_actions of this CreateDesktopPoolDetails.

Return type

oci.desktops.models.CreateDesktopPoolDesktopSessionLifecycleActions

property shape_config

Gets the shape_config of this CreateDesktopPoolDetails.

Returns

The shape_config of this CreateDesktopPoolDetails.

Return type

oci.desktops.models.CreateDesktopPoolShapeConfigDetails

property shape_name

[Required] Gets the shape_name of this CreateDesktopPoolDetails. The shape of the desktop pool.

Returns

The shape_name of this CreateDesktopPoolDetails.

Return type

str

property standby_size

[Required] Gets the standby_size of this CreateDesktopPoolDetails. The maximum number of standby desktops available in the desktop pool.

Returns

The standby_size of this CreateDesktopPoolDetails.

Return type

int

property storage_backup_policy_id

[Required] Gets the storage_backup_policy_id of this CreateDesktopPoolDetails. The backup policy OCID of the storage.

Returns

The storage_backup_policy_id of this CreateDesktopPoolDetails.

Return type

str

property storage_size_in_gbs

[Required] Gets the storage_size_in_gbs of this CreateDesktopPoolDetails. The size in GBs of the storage for the desktop pool.

Returns

The storage_size_in_gbs of this CreateDesktopPoolDetails.

Return type

int

property time_start_scheduled

Gets the time_start_scheduled of this CreateDesktopPoolDetails. The start time of the desktop pool.

Returns

The time_start_scheduled of this CreateDesktopPoolDetails.

Return type

datetime

property time_stop_scheduled

Gets the time_stop_scheduled of this CreateDesktopPoolDetails. The stop time of the desktop pool.

Returns

The time_stop_scheduled of this CreateDesktopPoolDetails.

Return type

datetime

property use_dedicated_vm_host

Gets the use_dedicated_vm_host of this CreateDesktopPoolDetails. Indicates whether the desktop pool uses dedicated virtual machine hosts.

Allowed values for this property are: “TRUE”, “FALSE”, “AUTO”

Returns

The use_dedicated_vm_host of this CreateDesktopPoolDetails.

Return type

str