oci.Desktops.DesktopPool
Explore with Pulumi AI
This resource provides the Desktop Pool resource in Oracle Cloud Infrastructure Desktops service.
Creates a desktop pool with the given configuration parameters.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDesktopPool = new oci.desktops.DesktopPool("test_desktop_pool", {
arePrivilegedUsers: desktopPoolArePrivilegedUsers,
availabilityDomain: desktopPoolAvailabilityDomain,
availabilityPolicy: {
startSchedule: {
cronExpression: "0 10 8 ? * 2",
timezone: "America/Denver",
},
stopSchedule: {
cronExpression: "0 20 18 ? * 6",
timezone: "America/Denver",
},
},
compartmentId: compartmentId,
contactDetails: desktopPoolContactDetails,
devicePolicy: {
audioMode: desktopPoolDevicePolicyAudioMode,
cdmMode: desktopPoolDevicePolicyCdmMode,
clipboardMode: desktopPoolDevicePolicyClipboardMode,
isDisplayEnabled: desktopPoolDevicePolicyIsDisplayEnabled,
isKeyboardEnabled: desktopPoolDevicePolicyIsKeyboardEnabled,
isPointerEnabled: desktopPoolDevicePolicyIsPointerEnabled,
isPrintingEnabled: desktopPoolDevicePolicyIsPrintingEnabled,
},
displayName: desktopPoolDisplayName,
image: {
imageId: testImage.id,
imageName: desktopPoolImageImageName,
operatingSystem: desktopPoolImageOperatingSystem,
},
isStorageEnabled: desktopPoolIsStorageEnabled,
maximumSize: desktopPoolMaximumSize,
networkConfiguration: {
subnetId: testSubnet.id,
vcnId: testVcn.id,
},
shapeName: "VM.Standard.E4.Flex",
standbySize: desktopPoolStandbySize,
storageBackupPolicyId: "ocid1.volumebackuppolicy.oc1.xxxxyyyyyzzzz",
storageSizeInGbs: desktopPoolStorageSizeInGbs,
areVolumesPreserved: desktopPoolAreVolumesPreserved,
definedTags: {
"Operations.CostCenter": "42",
},
description: desktopPoolDescription,
freeformTags: {
Department: "Finance",
},
nsgIds: desktopPoolNsgIds,
shapeConfig: {
baselineOcpuUtilization: desktopPoolShapeConfigBaselineOcpuUtilization,
memoryInGbs: desktopPoolShapeConfigMemoryInGbs,
ocpus: desktopPoolShapeConfigOcpus,
},
privateAccessDetails: {
subnetId: testSubnet.id,
nsgIds: desktopPoolPrivateAccessDetailsNsgIds,
privateIp: desktopPoolPrivateAccessDetailsPrivateIp,
},
sessionLifecycleActions: {
disconnect: {
action: "STOP",
gracePeriodInMinutes: desktopPoolSessionLifecycleActionsDisconnectGracePeriodInMinutes,
},
inactivity: {
action: "DISCONNECT",
gracePeriodInMinutes: desktopPoolSessionLifecycleActionsInactivityGracePeriodInMinutes,
},
},
timeStartScheduled: desktopPoolTimeStartScheduled,
timeStopScheduled: desktopPoolTimeStopScheduled,
useDedicatedVmHost: desktopPoolUseDedicatedVmHost,
});
import pulumi
import pulumi_oci as oci
test_desktop_pool = oci.desktops.DesktopPool("test_desktop_pool",
are_privileged_users=desktop_pool_are_privileged_users,
availability_domain=desktop_pool_availability_domain,
availability_policy={
"start_schedule": {
"cron_expression": "0 10 8 ? * 2",
"timezone": "America/Denver",
},
"stop_schedule": {
"cron_expression": "0 20 18 ? * 6",
"timezone": "America/Denver",
},
},
compartment_id=compartment_id,
contact_details=desktop_pool_contact_details,
device_policy={
"audio_mode": desktop_pool_device_policy_audio_mode,
"cdm_mode": desktop_pool_device_policy_cdm_mode,
"clipboard_mode": desktop_pool_device_policy_clipboard_mode,
"is_display_enabled": desktop_pool_device_policy_is_display_enabled,
"is_keyboard_enabled": desktop_pool_device_policy_is_keyboard_enabled,
"is_pointer_enabled": desktop_pool_device_policy_is_pointer_enabled,
"is_printing_enabled": desktop_pool_device_policy_is_printing_enabled,
},
display_name=desktop_pool_display_name,
image={
"image_id": test_image["id"],
"image_name": desktop_pool_image_image_name,
"operating_system": desktop_pool_image_operating_system,
},
is_storage_enabled=desktop_pool_is_storage_enabled,
maximum_size=desktop_pool_maximum_size,
network_configuration={
"subnet_id": test_subnet["id"],
"vcn_id": test_vcn["id"],
},
shape_name="VM.Standard.E4.Flex",
standby_size=desktop_pool_standby_size,
storage_backup_policy_id="ocid1.volumebackuppolicy.oc1.xxxxyyyyyzzzz",
storage_size_in_gbs=desktop_pool_storage_size_in_gbs,
are_volumes_preserved=desktop_pool_are_volumes_preserved,
defined_tags={
"Operations.CostCenter": "42",
},
description=desktop_pool_description,
freeform_tags={
"Department": "Finance",
},
nsg_ids=desktop_pool_nsg_ids,
shape_config={
"baseline_ocpu_utilization": desktop_pool_shape_config_baseline_ocpu_utilization,
"memory_in_gbs": desktop_pool_shape_config_memory_in_gbs,
"ocpus": desktop_pool_shape_config_ocpus,
},
private_access_details={
"subnet_id": test_subnet["id"],
"nsg_ids": desktop_pool_private_access_details_nsg_ids,
"private_ip": desktop_pool_private_access_details_private_ip,
},
session_lifecycle_actions={
"disconnect": {
"action": "STOP",
"grace_period_in_minutes": desktop_pool_session_lifecycle_actions_disconnect_grace_period_in_minutes,
},
"inactivity": {
"action": "DISCONNECT",
"grace_period_in_minutes": desktop_pool_session_lifecycle_actions_inactivity_grace_period_in_minutes,
},
},
time_start_scheduled=desktop_pool_time_start_scheduled,
time_stop_scheduled=desktop_pool_time_stop_scheduled,
use_dedicated_vm_host=desktop_pool_use_dedicated_vm_host)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Desktops"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Desktops.NewDesktopPool(ctx, "test_desktop_pool", &Desktops.DesktopPoolArgs{
ArePrivilegedUsers: pulumi.Any(desktopPoolArePrivilegedUsers),
AvailabilityDomain: pulumi.Any(desktopPoolAvailabilityDomain),
AvailabilityPolicy: &desktops.DesktopPoolAvailabilityPolicyArgs{
StartSchedule: &desktops.DesktopPoolAvailabilityPolicyStartScheduleArgs{
CronExpression: pulumi.String("0 10 8 ? * 2"),
Timezone: pulumi.String("America/Denver"),
},
StopSchedule: &desktops.DesktopPoolAvailabilityPolicyStopScheduleArgs{
CronExpression: pulumi.String("0 20 18 ? * 6"),
Timezone: pulumi.String("America/Denver"),
},
},
CompartmentId: pulumi.Any(compartmentId),
ContactDetails: pulumi.Any(desktopPoolContactDetails),
DevicePolicy: &desktops.DesktopPoolDevicePolicyArgs{
AudioMode: pulumi.Any(desktopPoolDevicePolicyAudioMode),
CdmMode: pulumi.Any(desktopPoolDevicePolicyCdmMode),
ClipboardMode: pulumi.Any(desktopPoolDevicePolicyClipboardMode),
IsDisplayEnabled: pulumi.Any(desktopPoolDevicePolicyIsDisplayEnabled),
IsKeyboardEnabled: pulumi.Any(desktopPoolDevicePolicyIsKeyboardEnabled),
IsPointerEnabled: pulumi.Any(desktopPoolDevicePolicyIsPointerEnabled),
IsPrintingEnabled: pulumi.Any(desktopPoolDevicePolicyIsPrintingEnabled),
},
DisplayName: pulumi.Any(desktopPoolDisplayName),
Image: &desktops.DesktopPoolImageArgs{
ImageId: pulumi.Any(testImage.Id),
ImageName: pulumi.Any(desktopPoolImageImageName),
OperatingSystem: pulumi.Any(desktopPoolImageOperatingSystem),
},
IsStorageEnabled: pulumi.Any(desktopPoolIsStorageEnabled),
MaximumSize: pulumi.Any(desktopPoolMaximumSize),
NetworkConfiguration: &desktops.DesktopPoolNetworkConfigurationArgs{
SubnetId: pulumi.Any(testSubnet.Id),
VcnId: pulumi.Any(testVcn.Id),
},
ShapeName: pulumi.String("VM.Standard.E4.Flex"),
StandbySize: pulumi.Any(desktopPoolStandbySize),
StorageBackupPolicyId: pulumi.String("ocid1.volumebackuppolicy.oc1.xxxxyyyyyzzzz"),
StorageSizeInGbs: pulumi.Any(desktopPoolStorageSizeInGbs),
AreVolumesPreserved: pulumi.Any(desktopPoolAreVolumesPreserved),
DefinedTags: pulumi.StringMap{
"Operations.CostCenter": pulumi.String("42"),
},
Description: pulumi.Any(desktopPoolDescription),
FreeformTags: pulumi.StringMap{
"Department": pulumi.String("Finance"),
},
NsgIds: pulumi.Any(desktopPoolNsgIds),
ShapeConfig: &desktops.DesktopPoolShapeConfigArgs{
BaselineOcpuUtilization: pulumi.Any(desktopPoolShapeConfigBaselineOcpuUtilization),
MemoryInGbs: pulumi.Any(desktopPoolShapeConfigMemoryInGbs),
Ocpus: pulumi.Any(desktopPoolShapeConfigOcpus),
},
PrivateAccessDetails: &desktops.DesktopPoolPrivateAccessDetailsArgs{
SubnetId: pulumi.Any(testSubnet.Id),
NsgIds: pulumi.Any(desktopPoolPrivateAccessDetailsNsgIds),
PrivateIp: pulumi.Any(desktopPoolPrivateAccessDetailsPrivateIp),
},
SessionLifecycleActions: &desktops.DesktopPoolSessionLifecycleActionsArgs{
Disconnect: &desktops.DesktopPoolSessionLifecycleActionsDisconnectArgs{
Action: pulumi.String("STOP"),
GracePeriodInMinutes: pulumi.Any(desktopPoolSessionLifecycleActionsDisconnectGracePeriodInMinutes),
},
Inactivity: &desktops.DesktopPoolSessionLifecycleActionsInactivityArgs{
Action: pulumi.String("DISCONNECT"),
GracePeriodInMinutes: pulumi.Any(desktopPoolSessionLifecycleActionsInactivityGracePeriodInMinutes),
},
},
TimeStartScheduled: pulumi.Any(desktopPoolTimeStartScheduled),
TimeStopScheduled: pulumi.Any(desktopPoolTimeStopScheduled),
UseDedicatedVmHost: pulumi.Any(desktopPoolUseDedicatedVmHost),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testDesktopPool = new Oci.Desktops.DesktopPool("test_desktop_pool", new()
{
ArePrivilegedUsers = desktopPoolArePrivilegedUsers,
AvailabilityDomain = desktopPoolAvailabilityDomain,
AvailabilityPolicy = new Oci.Desktops.Inputs.DesktopPoolAvailabilityPolicyArgs
{
StartSchedule = new Oci.Desktops.Inputs.DesktopPoolAvailabilityPolicyStartScheduleArgs
{
CronExpression = "0 10 8 ? * 2",
Timezone = "America/Denver",
},
StopSchedule = new Oci.Desktops.Inputs.DesktopPoolAvailabilityPolicyStopScheduleArgs
{
CronExpression = "0 20 18 ? * 6",
Timezone = "America/Denver",
},
},
CompartmentId = compartmentId,
ContactDetails = desktopPoolContactDetails,
DevicePolicy = new Oci.Desktops.Inputs.DesktopPoolDevicePolicyArgs
{
AudioMode = desktopPoolDevicePolicyAudioMode,
CdmMode = desktopPoolDevicePolicyCdmMode,
ClipboardMode = desktopPoolDevicePolicyClipboardMode,
IsDisplayEnabled = desktopPoolDevicePolicyIsDisplayEnabled,
IsKeyboardEnabled = desktopPoolDevicePolicyIsKeyboardEnabled,
IsPointerEnabled = desktopPoolDevicePolicyIsPointerEnabled,
IsPrintingEnabled = desktopPoolDevicePolicyIsPrintingEnabled,
},
DisplayName = desktopPoolDisplayName,
Image = new Oci.Desktops.Inputs.DesktopPoolImageArgs
{
ImageId = testImage.Id,
ImageName = desktopPoolImageImageName,
OperatingSystem = desktopPoolImageOperatingSystem,
},
IsStorageEnabled = desktopPoolIsStorageEnabled,
MaximumSize = desktopPoolMaximumSize,
NetworkConfiguration = new Oci.Desktops.Inputs.DesktopPoolNetworkConfigurationArgs
{
SubnetId = testSubnet.Id,
VcnId = testVcn.Id,
},
ShapeName = "VM.Standard.E4.Flex",
StandbySize = desktopPoolStandbySize,
StorageBackupPolicyId = "ocid1.volumebackuppolicy.oc1.xxxxyyyyyzzzz",
StorageSizeInGbs = desktopPoolStorageSizeInGbs,
AreVolumesPreserved = desktopPoolAreVolumesPreserved,
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
Description = desktopPoolDescription,
FreeformTags =
{
{ "Department", "Finance" },
},
NsgIds = desktopPoolNsgIds,
ShapeConfig = new Oci.Desktops.Inputs.DesktopPoolShapeConfigArgs
{
BaselineOcpuUtilization = desktopPoolShapeConfigBaselineOcpuUtilization,
MemoryInGbs = desktopPoolShapeConfigMemoryInGbs,
Ocpus = desktopPoolShapeConfigOcpus,
},
PrivateAccessDetails = new Oci.Desktops.Inputs.DesktopPoolPrivateAccessDetailsArgs
{
SubnetId = testSubnet.Id,
NsgIds = desktopPoolPrivateAccessDetailsNsgIds,
PrivateIp = desktopPoolPrivateAccessDetailsPrivateIp,
},
SessionLifecycleActions = new Oci.Desktops.Inputs.DesktopPoolSessionLifecycleActionsArgs
{
Disconnect = new Oci.Desktops.Inputs.DesktopPoolSessionLifecycleActionsDisconnectArgs
{
Action = "STOP",
GracePeriodInMinutes = desktopPoolSessionLifecycleActionsDisconnectGracePeriodInMinutes,
},
Inactivity = new Oci.Desktops.Inputs.DesktopPoolSessionLifecycleActionsInactivityArgs
{
Action = "DISCONNECT",
GracePeriodInMinutes = desktopPoolSessionLifecycleActionsInactivityGracePeriodInMinutes,
},
},
TimeStartScheduled = desktopPoolTimeStartScheduled,
TimeStopScheduled = desktopPoolTimeStopScheduled,
UseDedicatedVmHost = desktopPoolUseDedicatedVmHost,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Desktops.DesktopPool;
import com.pulumi.oci.Desktops.DesktopPoolArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolAvailabilityPolicyArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolAvailabilityPolicyStartScheduleArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolAvailabilityPolicyStopScheduleArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolDevicePolicyArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolImageArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolNetworkConfigurationArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolShapeConfigArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolPrivateAccessDetailsArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolSessionLifecycleActionsArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolSessionLifecycleActionsDisconnectArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolSessionLifecycleActionsInactivityArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testDesktopPool = new DesktopPool("testDesktopPool", DesktopPoolArgs.builder()
.arePrivilegedUsers(desktopPoolArePrivilegedUsers)
.availabilityDomain(desktopPoolAvailabilityDomain)
.availabilityPolicy(DesktopPoolAvailabilityPolicyArgs.builder()
.startSchedule(DesktopPoolAvailabilityPolicyStartScheduleArgs.builder()
.cronExpression("0 10 8 ? * 2")
.timezone("America/Denver")
.build())
.stopSchedule(DesktopPoolAvailabilityPolicyStopScheduleArgs.builder()
.cronExpression("0 20 18 ? * 6")
.timezone("America/Denver")
.build())
.build())
.compartmentId(compartmentId)
.contactDetails(desktopPoolContactDetails)
.devicePolicy(DesktopPoolDevicePolicyArgs.builder()
.audioMode(desktopPoolDevicePolicyAudioMode)
.cdmMode(desktopPoolDevicePolicyCdmMode)
.clipboardMode(desktopPoolDevicePolicyClipboardMode)
.isDisplayEnabled(desktopPoolDevicePolicyIsDisplayEnabled)
.isKeyboardEnabled(desktopPoolDevicePolicyIsKeyboardEnabled)
.isPointerEnabled(desktopPoolDevicePolicyIsPointerEnabled)
.isPrintingEnabled(desktopPoolDevicePolicyIsPrintingEnabled)
.build())
.displayName(desktopPoolDisplayName)
.image(DesktopPoolImageArgs.builder()
.imageId(testImage.id())
.imageName(desktopPoolImageImageName)
.operatingSystem(desktopPoolImageOperatingSystem)
.build())
.isStorageEnabled(desktopPoolIsStorageEnabled)
.maximumSize(desktopPoolMaximumSize)
.networkConfiguration(DesktopPoolNetworkConfigurationArgs.builder()
.subnetId(testSubnet.id())
.vcnId(testVcn.id())
.build())
.shapeName("VM.Standard.E4.Flex")
.standbySize(desktopPoolStandbySize)
.storageBackupPolicyId("ocid1.volumebackuppolicy.oc1.xxxxyyyyyzzzz")
.storageSizeInGbs(desktopPoolStorageSizeInGbs)
.areVolumesPreserved(desktopPoolAreVolumesPreserved)
.definedTags(Map.of("Operations.CostCenter", "42"))
.description(desktopPoolDescription)
.freeformTags(Map.of("Department", "Finance"))
.nsgIds(desktopPoolNsgIds)
.shapeConfig(DesktopPoolShapeConfigArgs.builder()
.baselineOcpuUtilization(desktopPoolShapeConfigBaselineOcpuUtilization)
.memoryInGbs(desktopPoolShapeConfigMemoryInGbs)
.ocpus(desktopPoolShapeConfigOcpus)
.build())
.privateAccessDetails(DesktopPoolPrivateAccessDetailsArgs.builder()
.subnetId(testSubnet.id())
.nsgIds(desktopPoolPrivateAccessDetailsNsgIds)
.privateIp(desktopPoolPrivateAccessDetailsPrivateIp)
.build())
.sessionLifecycleActions(DesktopPoolSessionLifecycleActionsArgs.builder()
.disconnect(DesktopPoolSessionLifecycleActionsDisconnectArgs.builder()
.action("STOP")
.gracePeriodInMinutes(desktopPoolSessionLifecycleActionsDisconnectGracePeriodInMinutes)
.build())
.inactivity(DesktopPoolSessionLifecycleActionsInactivityArgs.builder()
.action("DISCONNECT")
.gracePeriodInMinutes(desktopPoolSessionLifecycleActionsInactivityGracePeriodInMinutes)
.build())
.build())
.timeStartScheduled(desktopPoolTimeStartScheduled)
.timeStopScheduled(desktopPoolTimeStopScheduled)
.useDedicatedVmHost(desktopPoolUseDedicatedVmHost)
.build());
}
}
resources:
testDesktopPool:
type: oci:Desktops:DesktopPool
name: test_desktop_pool
properties:
arePrivilegedUsers: ${desktopPoolArePrivilegedUsers}
availabilityDomain: ${desktopPoolAvailabilityDomain}
availabilityPolicy:
startSchedule:
cronExpression: 0 10 8 ? * 2
timezone: America/Denver
stopSchedule:
cronExpression: 0 20 18 ? * 6
timezone: America/Denver
compartmentId: ${compartmentId}
contactDetails: ${desktopPoolContactDetails}
devicePolicy:
audioMode: ${desktopPoolDevicePolicyAudioMode}
cdmMode: ${desktopPoolDevicePolicyCdmMode}
clipboardMode: ${desktopPoolDevicePolicyClipboardMode}
isDisplayEnabled: ${desktopPoolDevicePolicyIsDisplayEnabled}
isKeyboardEnabled: ${desktopPoolDevicePolicyIsKeyboardEnabled}
isPointerEnabled: ${desktopPoolDevicePolicyIsPointerEnabled}
isPrintingEnabled: ${desktopPoolDevicePolicyIsPrintingEnabled}
displayName: ${desktopPoolDisplayName}
image:
imageId: ${testImage.id}
imageName: ${desktopPoolImageImageName}
operatingSystem: ${desktopPoolImageOperatingSystem}
isStorageEnabled: ${desktopPoolIsStorageEnabled}
maximumSize: ${desktopPoolMaximumSize}
networkConfiguration:
subnetId: ${testSubnet.id}
vcnId: ${testVcn.id}
shapeName: VM.Standard.E4.Flex
standbySize: ${desktopPoolStandbySize}
storageBackupPolicyId: ocid1.volumebackuppolicy.oc1.xxxxyyyyyzzzz
storageSizeInGbs: ${desktopPoolStorageSizeInGbs}
areVolumesPreserved: ${desktopPoolAreVolumesPreserved}
definedTags:
Operations.CostCenter: '42'
description: ${desktopPoolDescription}
freeformTags:
Department: Finance
nsgIds: ${desktopPoolNsgIds}
shapeConfig:
baselineOcpuUtilization: ${desktopPoolShapeConfigBaselineOcpuUtilization}
memoryInGbs: ${desktopPoolShapeConfigMemoryInGbs}
ocpus: ${desktopPoolShapeConfigOcpus}
privateAccessDetails:
subnetId: ${testSubnet.id}
nsgIds: ${desktopPoolPrivateAccessDetailsNsgIds}
privateIp: ${desktopPoolPrivateAccessDetailsPrivateIp}
sessionLifecycleActions:
disconnect:
action: STOP
gracePeriodInMinutes: ${desktopPoolSessionLifecycleActionsDisconnectGracePeriodInMinutes}
inactivity:
action: DISCONNECT
gracePeriodInMinutes: ${desktopPoolSessionLifecycleActionsInactivityGracePeriodInMinutes}
timeStartScheduled: ${desktopPoolTimeStartScheduled}
timeStopScheduled: ${desktopPoolTimeStopScheduled}
useDedicatedVmHost: ${desktopPoolUseDedicatedVmHost}
Create DesktopPool Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DesktopPool(name: string, args: DesktopPoolArgs, opts?: CustomResourceOptions);
@overload
def DesktopPool(resource_name: str,
args: DesktopPoolArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DesktopPool(resource_name: str,
opts: Optional[ResourceOptions] = None,
are_privileged_users: Optional[bool] = None,
device_policy: Optional[_desktops.DesktopPoolDevicePolicyArgs] = None,
availability_domain: Optional[str] = None,
availability_policy: Optional[_desktops.DesktopPoolAvailabilityPolicyArgs] = None,
compartment_id: Optional[str] = None,
contact_details: Optional[str] = None,
storage_size_in_gbs: Optional[int] = None,
storage_backup_policy_id: Optional[str] = None,
shape_name: Optional[str] = None,
display_name: Optional[str] = None,
standby_size: Optional[int] = None,
image: Optional[_desktops.DesktopPoolImageArgs] = None,
is_storage_enabled: Optional[bool] = None,
maximum_size: Optional[int] = None,
network_configuration: Optional[_desktops.DesktopPoolNetworkConfigurationArgs] = None,
defined_tags: Optional[Mapping[str, str]] = None,
private_access_details: Optional[_desktops.DesktopPoolPrivateAccessDetailsArgs] = None,
session_lifecycle_actions: Optional[_desktops.DesktopPoolSessionLifecycleActionsArgs] = None,
shape_config: Optional[_desktops.DesktopPoolShapeConfigArgs] = None,
nsg_ids: Optional[Sequence[str]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
are_volumes_preserved: Optional[bool] = None,
time_start_scheduled: Optional[str] = None,
time_stop_scheduled: Optional[str] = None,
use_dedicated_vm_host: Optional[str] = None)
func NewDesktopPool(ctx *Context, name string, args DesktopPoolArgs, opts ...ResourceOption) (*DesktopPool, error)
public DesktopPool(string name, DesktopPoolArgs args, CustomResourceOptions? opts = null)
public DesktopPool(String name, DesktopPoolArgs args)
public DesktopPool(String name, DesktopPoolArgs args, CustomResourceOptions options)
type: oci:Desktops:DesktopPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DesktopPoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DesktopPoolArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DesktopPoolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DesktopPoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DesktopPoolArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var desktopPoolResource = new Oci.Desktops.DesktopPool("desktopPoolResource", new()
{
ArePrivilegedUsers = false,
DevicePolicy = new Oci.Desktops.Inputs.DesktopPoolDevicePolicyArgs
{
AudioMode = "string",
CdmMode = "string",
ClipboardMode = "string",
IsDisplayEnabled = false,
IsKeyboardEnabled = false,
IsPointerEnabled = false,
IsPrintingEnabled = false,
},
AvailabilityDomain = "string",
AvailabilityPolicy = new Oci.Desktops.Inputs.DesktopPoolAvailabilityPolicyArgs
{
StartSchedule = new Oci.Desktops.Inputs.DesktopPoolAvailabilityPolicyStartScheduleArgs
{
CronExpression = "string",
Timezone = "string",
},
StopSchedule = new Oci.Desktops.Inputs.DesktopPoolAvailabilityPolicyStopScheduleArgs
{
CronExpression = "string",
Timezone = "string",
},
},
CompartmentId = "string",
ContactDetails = "string",
StorageSizeInGbs = 0,
StorageBackupPolicyId = "string",
ShapeName = "string",
DisplayName = "string",
StandbySize = 0,
Image = new Oci.Desktops.Inputs.DesktopPoolImageArgs
{
ImageId = "string",
ImageName = "string",
OperatingSystem = "string",
},
IsStorageEnabled = false,
MaximumSize = 0,
NetworkConfiguration = new Oci.Desktops.Inputs.DesktopPoolNetworkConfigurationArgs
{
SubnetId = "string",
VcnId = "string",
},
DefinedTags =
{
{ "string", "string" },
},
PrivateAccessDetails = new Oci.Desktops.Inputs.DesktopPoolPrivateAccessDetailsArgs
{
SubnetId = "string",
EndpointFqdn = "string",
NsgIds = new[]
{
"string",
},
PrivateIp = "string",
VcnId = "string",
},
SessionLifecycleActions = new Oci.Desktops.Inputs.DesktopPoolSessionLifecycleActionsArgs
{
Disconnect = new Oci.Desktops.Inputs.DesktopPoolSessionLifecycleActionsDisconnectArgs
{
Action = "string",
GracePeriodInMinutes = 0,
},
Inactivity = new Oci.Desktops.Inputs.DesktopPoolSessionLifecycleActionsInactivityArgs
{
Action = "string",
GracePeriodInMinutes = 0,
},
},
ShapeConfig = new Oci.Desktops.Inputs.DesktopPoolShapeConfigArgs
{
BaselineOcpuUtilization = "string",
MemoryInGbs = "string",
Ocpus = "string",
},
NsgIds = new[]
{
"string",
},
FreeformTags =
{
{ "string", "string" },
},
Description = "string",
AreVolumesPreserved = false,
TimeStartScheduled = "string",
TimeStopScheduled = "string",
UseDedicatedVmHost = "string",
});
example, err := Desktops.NewDesktopPool(ctx, "desktopPoolResource", &Desktops.DesktopPoolArgs{
ArePrivilegedUsers: pulumi.Bool(false),
DevicePolicy: &desktops.DesktopPoolDevicePolicyArgs{
AudioMode: pulumi.String("string"),
CdmMode: pulumi.String("string"),
ClipboardMode: pulumi.String("string"),
IsDisplayEnabled: pulumi.Bool(false),
IsKeyboardEnabled: pulumi.Bool(false),
IsPointerEnabled: pulumi.Bool(false),
IsPrintingEnabled: pulumi.Bool(false),
},
AvailabilityDomain: pulumi.String("string"),
AvailabilityPolicy: &desktops.DesktopPoolAvailabilityPolicyArgs{
StartSchedule: &desktops.DesktopPoolAvailabilityPolicyStartScheduleArgs{
CronExpression: pulumi.String("string"),
Timezone: pulumi.String("string"),
},
StopSchedule: &desktops.DesktopPoolAvailabilityPolicyStopScheduleArgs{
CronExpression: pulumi.String("string"),
Timezone: pulumi.String("string"),
},
},
CompartmentId: pulumi.String("string"),
ContactDetails: pulumi.String("string"),
StorageSizeInGbs: pulumi.Int(0),
StorageBackupPolicyId: pulumi.String("string"),
ShapeName: pulumi.String("string"),
DisplayName: pulumi.String("string"),
StandbySize: pulumi.Int(0),
Image: &desktops.DesktopPoolImageArgs{
ImageId: pulumi.String("string"),
ImageName: pulumi.String("string"),
OperatingSystem: pulumi.String("string"),
},
IsStorageEnabled: pulumi.Bool(false),
MaximumSize: pulumi.Int(0),
NetworkConfiguration: &desktops.DesktopPoolNetworkConfigurationArgs{
SubnetId: pulumi.String("string"),
VcnId: pulumi.String("string"),
},
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
PrivateAccessDetails: &desktops.DesktopPoolPrivateAccessDetailsArgs{
SubnetId: pulumi.String("string"),
EndpointFqdn: pulumi.String("string"),
NsgIds: pulumi.StringArray{
pulumi.String("string"),
},
PrivateIp: pulumi.String("string"),
VcnId: pulumi.String("string"),
},
SessionLifecycleActions: &desktops.DesktopPoolSessionLifecycleActionsArgs{
Disconnect: &desktops.DesktopPoolSessionLifecycleActionsDisconnectArgs{
Action: pulumi.String("string"),
GracePeriodInMinutes: pulumi.Int(0),
},
Inactivity: &desktops.DesktopPoolSessionLifecycleActionsInactivityArgs{
Action: pulumi.String("string"),
GracePeriodInMinutes: pulumi.Int(0),
},
},
ShapeConfig: &desktops.DesktopPoolShapeConfigArgs{
BaselineOcpuUtilization: pulumi.String("string"),
MemoryInGbs: pulumi.String("string"),
Ocpus: pulumi.String("string"),
},
NsgIds: pulumi.StringArray{
pulumi.String("string"),
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
AreVolumesPreserved: pulumi.Bool(false),
TimeStartScheduled: pulumi.String("string"),
TimeStopScheduled: pulumi.String("string"),
UseDedicatedVmHost: pulumi.String("string"),
})
var desktopPoolResource = new DesktopPool("desktopPoolResource", DesktopPoolArgs.builder()
.arePrivilegedUsers(false)
.devicePolicy(DesktopPoolDevicePolicyArgs.builder()
.audioMode("string")
.cdmMode("string")
.clipboardMode("string")
.isDisplayEnabled(false)
.isKeyboardEnabled(false)
.isPointerEnabled(false)
.isPrintingEnabled(false)
.build())
.availabilityDomain("string")
.availabilityPolicy(DesktopPoolAvailabilityPolicyArgs.builder()
.startSchedule(DesktopPoolAvailabilityPolicyStartScheduleArgs.builder()
.cronExpression("string")
.timezone("string")
.build())
.stopSchedule(DesktopPoolAvailabilityPolicyStopScheduleArgs.builder()
.cronExpression("string")
.timezone("string")
.build())
.build())
.compartmentId("string")
.contactDetails("string")
.storageSizeInGbs(0)
.storageBackupPolicyId("string")
.shapeName("string")
.displayName("string")
.standbySize(0)
.image(DesktopPoolImageArgs.builder()
.imageId("string")
.imageName("string")
.operatingSystem("string")
.build())
.isStorageEnabled(false)
.maximumSize(0)
.networkConfiguration(DesktopPoolNetworkConfigurationArgs.builder()
.subnetId("string")
.vcnId("string")
.build())
.definedTags(Map.of("string", "string"))
.privateAccessDetails(DesktopPoolPrivateAccessDetailsArgs.builder()
.subnetId("string")
.endpointFqdn("string")
.nsgIds("string")
.privateIp("string")
.vcnId("string")
.build())
.sessionLifecycleActions(DesktopPoolSessionLifecycleActionsArgs.builder()
.disconnect(DesktopPoolSessionLifecycleActionsDisconnectArgs.builder()
.action("string")
.gracePeriodInMinutes(0)
.build())
.inactivity(DesktopPoolSessionLifecycleActionsInactivityArgs.builder()
.action("string")
.gracePeriodInMinutes(0)
.build())
.build())
.shapeConfig(DesktopPoolShapeConfigArgs.builder()
.baselineOcpuUtilization("string")
.memoryInGbs("string")
.ocpus("string")
.build())
.nsgIds("string")
.freeformTags(Map.of("string", "string"))
.description("string")
.areVolumesPreserved(false)
.timeStartScheduled("string")
.timeStopScheduled("string")
.useDedicatedVmHost("string")
.build());
desktop_pool_resource = oci.desktops.DesktopPool("desktopPoolResource",
are_privileged_users=False,
device_policy={
"audio_mode": "string",
"cdm_mode": "string",
"clipboard_mode": "string",
"is_display_enabled": False,
"is_keyboard_enabled": False,
"is_pointer_enabled": False,
"is_printing_enabled": False,
},
availability_domain="string",
availability_policy={
"start_schedule": {
"cron_expression": "string",
"timezone": "string",
},
"stop_schedule": {
"cron_expression": "string",
"timezone": "string",
},
},
compartment_id="string",
contact_details="string",
storage_size_in_gbs=0,
storage_backup_policy_id="string",
shape_name="string",
display_name="string",
standby_size=0,
image={
"image_id": "string",
"image_name": "string",
"operating_system": "string",
},
is_storage_enabled=False,
maximum_size=0,
network_configuration={
"subnet_id": "string",
"vcn_id": "string",
},
defined_tags={
"string": "string",
},
private_access_details={
"subnet_id": "string",
"endpoint_fqdn": "string",
"nsg_ids": ["string"],
"private_ip": "string",
"vcn_id": "string",
},
session_lifecycle_actions={
"disconnect": {
"action": "string",
"grace_period_in_minutes": 0,
},
"inactivity": {
"action": "string",
"grace_period_in_minutes": 0,
},
},
shape_config={
"baseline_ocpu_utilization": "string",
"memory_in_gbs": "string",
"ocpus": "string",
},
nsg_ids=["string"],
freeform_tags={
"string": "string",
},
description="string",
are_volumes_preserved=False,
time_start_scheduled="string",
time_stop_scheduled="string",
use_dedicated_vm_host="string")
const desktopPoolResource = new oci.desktops.DesktopPool("desktopPoolResource", {
arePrivilegedUsers: false,
devicePolicy: {
audioMode: "string",
cdmMode: "string",
clipboardMode: "string",
isDisplayEnabled: false,
isKeyboardEnabled: false,
isPointerEnabled: false,
isPrintingEnabled: false,
},
availabilityDomain: "string",
availabilityPolicy: {
startSchedule: {
cronExpression: "string",
timezone: "string",
},
stopSchedule: {
cronExpression: "string",
timezone: "string",
},
},
compartmentId: "string",
contactDetails: "string",
storageSizeInGbs: 0,
storageBackupPolicyId: "string",
shapeName: "string",
displayName: "string",
standbySize: 0,
image: {
imageId: "string",
imageName: "string",
operatingSystem: "string",
},
isStorageEnabled: false,
maximumSize: 0,
networkConfiguration: {
subnetId: "string",
vcnId: "string",
},
definedTags: {
string: "string",
},
privateAccessDetails: {
subnetId: "string",
endpointFqdn: "string",
nsgIds: ["string"],
privateIp: "string",
vcnId: "string",
},
sessionLifecycleActions: {
disconnect: {
action: "string",
gracePeriodInMinutes: 0,
},
inactivity: {
action: "string",
gracePeriodInMinutes: 0,
},
},
shapeConfig: {
baselineOcpuUtilization: "string",
memoryInGbs: "string",
ocpus: "string",
},
nsgIds: ["string"],
freeformTags: {
string: "string",
},
description: "string",
areVolumesPreserved: false,
timeStartScheduled: "string",
timeStopScheduled: "string",
useDedicatedVmHost: "string",
});
type: oci:Desktops:DesktopPool
properties:
arePrivilegedUsers: false
areVolumesPreserved: false
availabilityDomain: string
availabilityPolicy:
startSchedule:
cronExpression: string
timezone: string
stopSchedule:
cronExpression: string
timezone: string
compartmentId: string
contactDetails: string
definedTags:
string: string
description: string
devicePolicy:
audioMode: string
cdmMode: string
clipboardMode: string
isDisplayEnabled: false
isKeyboardEnabled: false
isPointerEnabled: false
isPrintingEnabled: false
displayName: string
freeformTags:
string: string
image:
imageId: string
imageName: string
operatingSystem: string
isStorageEnabled: false
maximumSize: 0
networkConfiguration:
subnetId: string
vcnId: string
nsgIds:
- string
privateAccessDetails:
endpointFqdn: string
nsgIds:
- string
privateIp: string
subnetId: string
vcnId: string
sessionLifecycleActions:
disconnect:
action: string
gracePeriodInMinutes: 0
inactivity:
action: string
gracePeriodInMinutes: 0
shapeConfig:
baselineOcpuUtilization: string
memoryInGbs: string
ocpus: string
shapeName: string
standbySize: 0
storageBackupPolicyId: string
storageSizeInGbs: 0
timeStartScheduled: string
timeStopScheduled: string
useDedicatedVmHost: string
DesktopPool Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DesktopPool resource accepts the following input properties:
- Are
Privileged boolUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- Availability
Domain string - The availability domain of the desktop pool.
- Availability
Policy DesktopPool Availability Policy - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool. Use
availability_policy { }
to not set a schedule. - Compartment
Id string - (Updatable) The OCID of the compartment which will contain the desktop pool.
- Contact
Details string - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- Device
Policy DesktopPool Device Policy - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- Display
Name string - (Updatable) A user friendly display name. Avoid entering confidential information.
- Image
Desktop
Pool Image - Provides information about the desktop image.
- Is
Storage boolEnabled - Indicates whether storage is enabled for the desktop pool.
- Maximum
Size int - (Updatable) The maximum number of desktops permitted in the desktop pool.
- Network
Configuration DesktopPool Network Configuration - Provides information about the network configuration of the desktop pool.
- Shape
Name string - The shape of the desktop pool.
- Standby
Size int - (Updatable) The maximum number of standby desktops available in the desktop pool.
- Storage
Backup stringPolicy Id - The backup policy OCID of the storage.
- Storage
Size intIn Gbs - The size in GBs of the storage for the desktop pool.
- Are
Volumes boolPreserved (Updatable) Indicates whether the volumes are preserved when a desktop pool is deleted. Default value is false.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) 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"}
- Nsg
Ids List<string> - A list of network security groups for the private access.
- Private
Access DesktopDetails Pool Private Access Details - The details of the desktop's private access network connectivity to be set up for the desktop pool.
- Session
Lifecycle DesktopActions Pool Session Lifecycle Actions - The details of action to be triggered in case of inactivity or disconnect
- Shape
Config DesktopPool Shape Config - The compute instance shape configuration requested for each desktop in the desktop pool.
- Time
Start stringScheduled - (Updatable) The start time of the desktop pool.
- Time
Stop stringScheduled - (Updatable) The stop time of the desktop pool.
- Use
Dedicated stringVm Host - Indicates whether the desktop pool uses dedicated virtual machine hosts.
- Are
Privileged boolUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- Availability
Domain string - The availability domain of the desktop pool.
- Availability
Policy DesktopPool Availability Policy Args - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool. Use
availability_policy { }
to not set a schedule. - Compartment
Id string - (Updatable) The OCID of the compartment which will contain the desktop pool.
- Contact
Details string - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- Device
Policy DesktopPool Device Policy Args - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- Display
Name string - (Updatable) A user friendly display name. Avoid entering confidential information.
- Image
Desktop
Pool Image Args - Provides information about the desktop image.
- Is
Storage boolEnabled - Indicates whether storage is enabled for the desktop pool.
- Maximum
Size int - (Updatable) The maximum number of desktops permitted in the desktop pool.
- Network
Configuration DesktopPool Network Configuration Args - Provides information about the network configuration of the desktop pool.
- Shape
Name string - The shape of the desktop pool.
- Standby
Size int - (Updatable) The maximum number of standby desktops available in the desktop pool.
- Storage
Backup stringPolicy Id - The backup policy OCID of the storage.
- Storage
Size intIn Gbs - The size in GBs of the storage for the desktop pool.
- Are
Volumes boolPreserved (Updatable) Indicates whether the volumes are preserved when a desktop pool is deleted. Default value is false.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- map[string]string
- (Updatable) 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"}
- Nsg
Ids []string - A list of network security groups for the private access.
- Private
Access DesktopDetails Pool Private Access Details Args - The details of the desktop's private access network connectivity to be set up for the desktop pool.
- Session
Lifecycle DesktopActions Pool Session Lifecycle Actions Args - The details of action to be triggered in case of inactivity or disconnect
- Shape
Config DesktopPool Shape Config Args - The compute instance shape configuration requested for each desktop in the desktop pool.
- Time
Start stringScheduled - (Updatable) The start time of the desktop pool.
- Time
Stop stringScheduled - (Updatable) The stop time of the desktop pool.
- Use
Dedicated stringVm Host - Indicates whether the desktop pool uses dedicated virtual machine hosts.
- are
Privileged BooleanUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- availability
Domain String - The availability domain of the desktop pool.
- availability
Policy DesktopPool Availability Policy - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool. Use
availability_policy { }
to not set a schedule. - compartment
Id String - (Updatable) The OCID of the compartment which will contain the desktop pool.
- contact
Details String - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- device
Policy DesktopPool Device Policy - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- display
Name String - (Updatable) A user friendly display name. Avoid entering confidential information.
- image
Desktop
Pool Image - Provides information about the desktop image.
- is
Storage BooleanEnabled - Indicates whether storage is enabled for the desktop pool.
- maximum
Size Integer - (Updatable) The maximum number of desktops permitted in the desktop pool.
- network
Configuration DesktopPool Network Configuration - Provides information about the network configuration of the desktop pool.
- shape
Name String - The shape of the desktop pool.
- standby
Size Integer - (Updatable) The maximum number of standby desktops available in the desktop pool.
- storage
Backup StringPolicy Id - The backup policy OCID of the storage.
- storage
Size IntegerIn Gbs - The size in GBs of the storage for the desktop pool.
- are
Volumes BooleanPreserved (Updatable) Indicates whether the volumes are preserved when a desktop pool is deleted. Default value is false.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- Map<String,String>
- (Updatable) 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"}
- nsg
Ids List<String> - A list of network security groups for the private access.
- private
Access DesktopDetails Pool Private Access Details - The details of the desktop's private access network connectivity to be set up for the desktop pool.
- session
Lifecycle DesktopActions Pool Session Lifecycle Actions - The details of action to be triggered in case of inactivity or disconnect
- shape
Config DesktopPool Shape Config - The compute instance shape configuration requested for each desktop in the desktop pool.
- time
Start StringScheduled - (Updatable) The start time of the desktop pool.
- time
Stop StringScheduled - (Updatable) The stop time of the desktop pool.
- use
Dedicated StringVm Host - Indicates whether the desktop pool uses dedicated virtual machine hosts.
- are
Privileged booleanUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- availability
Domain string - The availability domain of the desktop pool.
- availability
Policy DesktopPool Availability Policy - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool. Use
availability_policy { }
to not set a schedule. - compartment
Id string - (Updatable) The OCID of the compartment which will contain the desktop pool.
- contact
Details string - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- device
Policy DesktopPool Device Policy - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- display
Name string - (Updatable) A user friendly display name. Avoid entering confidential information.
- image
Desktop
Pool Image - Provides information about the desktop image.
- is
Storage booleanEnabled - Indicates whether storage is enabled for the desktop pool.
- maximum
Size number - (Updatable) The maximum number of desktops permitted in the desktop pool.
- network
Configuration DesktopPool Network Configuration - Provides information about the network configuration of the desktop pool.
- shape
Name string - The shape of the desktop pool.
- standby
Size number - (Updatable) The maximum number of standby desktops available in the desktop pool.
- storage
Backup stringPolicy Id - The backup policy OCID of the storage.
- storage
Size numberIn Gbs - The size in GBs of the storage for the desktop pool.
- are
Volumes booleanPreserved (Updatable) Indicates whether the volumes are preserved when a desktop pool is deleted. Default value is false.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description string
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) 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"}
- nsg
Ids string[] - A list of network security groups for the private access.
- private
Access DesktopDetails Pool Private Access Details - The details of the desktop's private access network connectivity to be set up for the desktop pool.
- session
Lifecycle DesktopActions Pool Session Lifecycle Actions - The details of action to be triggered in case of inactivity or disconnect
- shape
Config DesktopPool Shape Config - The compute instance shape configuration requested for each desktop in the desktop pool.
- time
Start stringScheduled - (Updatable) The start time of the desktop pool.
- time
Stop stringScheduled - (Updatable) The stop time of the desktop pool.
- use
Dedicated stringVm Host - Indicates whether the desktop pool uses dedicated virtual machine hosts.
- are_
privileged_ boolusers - Indicates whether desktop pool users have administrative privileges on their desktop.
- availability_
domain str - The availability domain of the desktop pool.
- availability_
policy desktops.Desktop Pool Availability Policy Args - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool. Use
availability_policy { }
to not set a schedule. - compartment_
id str - (Updatable) The OCID of the compartment which will contain the desktop pool.
- contact_
details str - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- device_
policy desktops.Desktop Pool Device Policy Args - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- display_
name str - (Updatable) A user friendly display name. Avoid entering confidential information.
- image
desktops.
Desktop Pool Image Args - Provides information about the desktop image.
- is_
storage_ boolenabled - Indicates whether storage is enabled for the desktop pool.
- maximum_
size int - (Updatable) The maximum number of desktops permitted in the desktop pool.
- network_
configuration desktops.Desktop Pool Network Configuration Args - Provides information about the network configuration of the desktop pool.
- shape_
name str - The shape of the desktop pool.
- standby_
size int - (Updatable) The maximum number of standby desktops available in the desktop pool.
- storage_
backup_ strpolicy_ id - The backup policy OCID of the storage.
- storage_
size_ intin_ gbs - The size in GBs of the storage for the desktop pool.
- are_
volumes_ boolpreserved (Updatable) Indicates whether the volumes are preserved when a desktop pool is deleted. Default value is false.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description str
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) 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"}
- nsg_
ids Sequence[str] - A list of network security groups for the private access.
- private_
access_ desktops.details Desktop Pool Private Access Details Args - The details of the desktop's private access network connectivity to be set up for the desktop pool.
- session_
lifecycle_ desktops.actions Desktop Pool Session Lifecycle Actions Args - The details of action to be triggered in case of inactivity or disconnect
- shape_
config desktops.Desktop Pool Shape Config Args - The compute instance shape configuration requested for each desktop in the desktop pool.
- time_
start_ strscheduled - (Updatable) The start time of the desktop pool.
- time_
stop_ strscheduled - (Updatable) The stop time of the desktop pool.
- use_
dedicated_ strvm_ host - Indicates whether the desktop pool uses dedicated virtual machine hosts.
- are
Privileged BooleanUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- availability
Domain String - The availability domain of the desktop pool.
- availability
Policy Property Map - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool. Use
availability_policy { }
to not set a schedule. - compartment
Id String - (Updatable) The OCID of the compartment which will contain the desktop pool.
- contact
Details String - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- device
Policy Property Map - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- display
Name String - (Updatable) A user friendly display name. Avoid entering confidential information.
- image Property Map
- Provides information about the desktop image.
- is
Storage BooleanEnabled - Indicates whether storage is enabled for the desktop pool.
- maximum
Size Number - (Updatable) The maximum number of desktops permitted in the desktop pool.
- network
Configuration Property Map - Provides information about the network configuration of the desktop pool.
- shape
Name String - The shape of the desktop pool.
- standby
Size Number - (Updatable) The maximum number of standby desktops available in the desktop pool.
- storage
Backup StringPolicy Id - The backup policy OCID of the storage.
- storage
Size NumberIn Gbs - The size in GBs of the storage for the desktop pool.
- are
Volumes BooleanPreserved (Updatable) Indicates whether the volumes are preserved when a desktop pool is deleted. Default value is false.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- Map<String>
- (Updatable) 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"}
- nsg
Ids List<String> - A list of network security groups for the private access.
- private
Access Property MapDetails - The details of the desktop's private access network connectivity to be set up for the desktop pool.
- session
Lifecycle Property MapActions - The details of action to be triggered in case of inactivity or disconnect
- shape
Config Property Map - The compute instance shape configuration requested for each desktop in the desktop pool.
- time
Start StringScheduled - (Updatable) The start time of the desktop pool.
- time
Stop StringScheduled - (Updatable) The stop time of the desktop pool.
- use
Dedicated StringVm Host - Indicates whether the desktop pool uses dedicated virtual machine hosts.
Outputs
All input properties are implicitly available as output properties. Additionally, the DesktopPool resource produces the following output properties:
- Active
Desktops int - The number of active desktops in the desktop pool.
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- The current state of the desktop pool.
- Time
Created string - The date and time the resource was created.
- Active
Desktops int - The number of active desktops in the desktop pool.
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- The current state of the desktop pool.
- Time
Created string - The date and time the resource was created.
- active
Desktops Integer - The number of active desktops in the desktop pool.
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- The current state of the desktop pool.
- time
Created String - The date and time the resource was created.
- active
Desktops number - The number of active desktops in the desktop pool.
- id string
- The provider-assigned unique ID for this managed resource.
- state string
- The current state of the desktop pool.
- time
Created string - The date and time the resource was created.
- active_
desktops int - The number of active desktops in the desktop pool.
- id str
- The provider-assigned unique ID for this managed resource.
- state str
- The current state of the desktop pool.
- time_
created str - The date and time the resource was created.
- active
Desktops Number - The number of active desktops in the desktop pool.
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- The current state of the desktop pool.
- time
Created String - The date and time the resource was created.
Look up Existing DesktopPool Resource
Get an existing DesktopPool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DesktopPoolState, opts?: CustomResourceOptions): DesktopPool
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
active_desktops: Optional[int] = None,
are_privileged_users: Optional[bool] = None,
are_volumes_preserved: Optional[bool] = None,
availability_domain: Optional[str] = None,
availability_policy: Optional[_desktops.DesktopPoolAvailabilityPolicyArgs] = None,
compartment_id: Optional[str] = None,
contact_details: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
device_policy: Optional[_desktops.DesktopPoolDevicePolicyArgs] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
image: Optional[_desktops.DesktopPoolImageArgs] = None,
is_storage_enabled: Optional[bool] = None,
maximum_size: Optional[int] = None,
network_configuration: Optional[_desktops.DesktopPoolNetworkConfigurationArgs] = None,
nsg_ids: Optional[Sequence[str]] = None,
private_access_details: Optional[_desktops.DesktopPoolPrivateAccessDetailsArgs] = None,
session_lifecycle_actions: Optional[_desktops.DesktopPoolSessionLifecycleActionsArgs] = None,
shape_config: Optional[_desktops.DesktopPoolShapeConfigArgs] = None,
shape_name: Optional[str] = None,
standby_size: Optional[int] = None,
state: Optional[str] = None,
storage_backup_policy_id: Optional[str] = None,
storage_size_in_gbs: Optional[int] = None,
time_created: Optional[str] = None,
time_start_scheduled: Optional[str] = None,
time_stop_scheduled: Optional[str] = None,
use_dedicated_vm_host: Optional[str] = None) -> DesktopPool
func GetDesktopPool(ctx *Context, name string, id IDInput, state *DesktopPoolState, opts ...ResourceOption) (*DesktopPool, error)
public static DesktopPool Get(string name, Input<string> id, DesktopPoolState? state, CustomResourceOptions? opts = null)
public static DesktopPool get(String name, Output<String> id, DesktopPoolState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Active
Desktops int - The number of active desktops in the desktop pool.
- Are
Privileged boolUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- Are
Volumes boolPreserved (Updatable) Indicates whether the volumes are preserved when a desktop pool is deleted. Default value is false.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Availability
Domain string - The availability domain of the desktop pool.
- Availability
Policy DesktopPool Availability Policy - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool. Use
availability_policy { }
to not set a schedule. - Compartment
Id string - (Updatable) The OCID of the compartment which will contain the desktop pool.
- Contact
Details string - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- Device
Policy DesktopPool Device Policy - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- Display
Name string - (Updatable) A user friendly display name. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) 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"}
- Image
Desktop
Pool Image - Provides information about the desktop image.
- Is
Storage boolEnabled - Indicates whether storage is enabled for the desktop pool.
- Maximum
Size int - (Updatable) The maximum number of desktops permitted in the desktop pool.
- Network
Configuration DesktopPool Network Configuration - Provides information about the network configuration of the desktop pool.
- Nsg
Ids List<string> - A list of network security groups for the private access.
- Private
Access DesktopDetails Pool Private Access Details - The details of the desktop's private access network connectivity to be set up for the desktop pool.
- Session
Lifecycle DesktopActions Pool Session Lifecycle Actions - The details of action to be triggered in case of inactivity or disconnect
- Shape
Config DesktopPool Shape Config - The compute instance shape configuration requested for each desktop in the desktop pool.
- Shape
Name string - The shape of the desktop pool.
- Standby
Size int - (Updatable) The maximum number of standby desktops available in the desktop pool.
- State string
- The current state of the desktop pool.
- Storage
Backup stringPolicy Id - The backup policy OCID of the storage.
- Storage
Size intIn Gbs - The size in GBs of the storage for the desktop pool.
- Time
Created string - The date and time the resource was created.
- Time
Start stringScheduled - (Updatable) The start time of the desktop pool.
- Time
Stop stringScheduled - (Updatable) The stop time of the desktop pool.
- Use
Dedicated stringVm Host - Indicates whether the desktop pool uses dedicated virtual machine hosts.
- Active
Desktops int - The number of active desktops in the desktop pool.
- Are
Privileged boolUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- Are
Volumes boolPreserved (Updatable) Indicates whether the volumes are preserved when a desktop pool is deleted. Default value is false.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Availability
Domain string - The availability domain of the desktop pool.
- Availability
Policy DesktopPool Availability Policy Args - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool. Use
availability_policy { }
to not set a schedule. - Compartment
Id string - (Updatable) The OCID of the compartment which will contain the desktop pool.
- Contact
Details string - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- Device
Policy DesktopPool Device Policy Args - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- Display
Name string - (Updatable) A user friendly display name. Avoid entering confidential information.
- map[string]string
- (Updatable) 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"}
- Image
Desktop
Pool Image Args - Provides information about the desktop image.
- Is
Storage boolEnabled - Indicates whether storage is enabled for the desktop pool.
- Maximum
Size int - (Updatable) The maximum number of desktops permitted in the desktop pool.
- Network
Configuration DesktopPool Network Configuration Args - Provides information about the network configuration of the desktop pool.
- Nsg
Ids []string - A list of network security groups for the private access.
- Private
Access DesktopDetails Pool Private Access Details Args - The details of the desktop's private access network connectivity to be set up for the desktop pool.
- Session
Lifecycle DesktopActions Pool Session Lifecycle Actions Args - The details of action to be triggered in case of inactivity or disconnect
- Shape
Config DesktopPool Shape Config Args - The compute instance shape configuration requested for each desktop in the desktop pool.
- Shape
Name string - The shape of the desktop pool.
- Standby
Size int - (Updatable) The maximum number of standby desktops available in the desktop pool.
- State string
- The current state of the desktop pool.
- Storage
Backup stringPolicy Id - The backup policy OCID of the storage.
- Storage
Size intIn Gbs - The size in GBs of the storage for the desktop pool.
- Time
Created string - The date and time the resource was created.
- Time
Start stringScheduled - (Updatable) The start time of the desktop pool.
- Time
Stop stringScheduled - (Updatable) The stop time of the desktop pool.
- Use
Dedicated stringVm Host - Indicates whether the desktop pool uses dedicated virtual machine hosts.
- active
Desktops Integer - The number of active desktops in the desktop pool.
- are
Privileged BooleanUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- are
Volumes BooleanPreserved (Updatable) Indicates whether the volumes are preserved when a desktop pool is deleted. Default value is false.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- availability
Domain String - The availability domain of the desktop pool.
- availability
Policy DesktopPool Availability Policy - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool. Use
availability_policy { }
to not set a schedule. - compartment
Id String - (Updatable) The OCID of the compartment which will contain the desktop pool.
- contact
Details String - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- device
Policy DesktopPool Device Policy - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- display
Name String - (Updatable) A user friendly display name. Avoid entering confidential information.
- Map<String,String>
- (Updatable) 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"}
- image
Desktop
Pool Image - Provides information about the desktop image.
- is
Storage BooleanEnabled - Indicates whether storage is enabled for the desktop pool.
- maximum
Size Integer - (Updatable) The maximum number of desktops permitted in the desktop pool.
- network
Configuration DesktopPool Network Configuration - Provides information about the network configuration of the desktop pool.
- nsg
Ids List<String> - A list of network security groups for the private access.
- private
Access DesktopDetails Pool Private Access Details - The details of the desktop's private access network connectivity to be set up for the desktop pool.
- session
Lifecycle DesktopActions Pool Session Lifecycle Actions - The details of action to be triggered in case of inactivity or disconnect
- shape
Config DesktopPool Shape Config - The compute instance shape configuration requested for each desktop in the desktop pool.
- shape
Name String - The shape of the desktop pool.
- standby
Size Integer - (Updatable) The maximum number of standby desktops available in the desktop pool.
- state String
- The current state of the desktop pool.
- storage
Backup StringPolicy Id - The backup policy OCID of the storage.
- storage
Size IntegerIn Gbs - The size in GBs of the storage for the desktop pool.
- time
Created String - The date and time the resource was created.
- time
Start StringScheduled - (Updatable) The start time of the desktop pool.
- time
Stop StringScheduled - (Updatable) The stop time of the desktop pool.
- use
Dedicated StringVm Host - Indicates whether the desktop pool uses dedicated virtual machine hosts.
- active
Desktops number - The number of active desktops in the desktop pool.
- are
Privileged booleanUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- are
Volumes booleanPreserved (Updatable) Indicates whether the volumes are preserved when a desktop pool is deleted. Default value is false.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- availability
Domain string - The availability domain of the desktop pool.
- availability
Policy DesktopPool Availability Policy - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool. Use
availability_policy { }
to not set a schedule. - compartment
Id string - (Updatable) The OCID of the compartment which will contain the desktop pool.
- contact
Details string - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description string
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- device
Policy DesktopPool Device Policy - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- display
Name string - (Updatable) A user friendly display name. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) 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"}
- image
Desktop
Pool Image - Provides information about the desktop image.
- is
Storage booleanEnabled - Indicates whether storage is enabled for the desktop pool.
- maximum
Size number - (Updatable) The maximum number of desktops permitted in the desktop pool.
- network
Configuration DesktopPool Network Configuration - Provides information about the network configuration of the desktop pool.
- nsg
Ids string[] - A list of network security groups for the private access.
- private
Access DesktopDetails Pool Private Access Details - The details of the desktop's private access network connectivity to be set up for the desktop pool.
- session
Lifecycle DesktopActions Pool Session Lifecycle Actions - The details of action to be triggered in case of inactivity or disconnect
- shape
Config DesktopPool Shape Config - The compute instance shape configuration requested for each desktop in the desktop pool.
- shape
Name string - The shape of the desktop pool.
- standby
Size number - (Updatable) The maximum number of standby desktops available in the desktop pool.
- state string
- The current state of the desktop pool.
- storage
Backup stringPolicy Id - The backup policy OCID of the storage.
- storage
Size numberIn Gbs - The size in GBs of the storage for the desktop pool.
- time
Created string - The date and time the resource was created.
- time
Start stringScheduled - (Updatable) The start time of the desktop pool.
- time
Stop stringScheduled - (Updatable) The stop time of the desktop pool.
- use
Dedicated stringVm Host - Indicates whether the desktop pool uses dedicated virtual machine hosts.
- active_
desktops int - The number of active desktops in the desktop pool.
- are_
privileged_ boolusers - Indicates whether desktop pool users have administrative privileges on their desktop.
- are_
volumes_ boolpreserved (Updatable) Indicates whether the volumes are preserved when a desktop pool is deleted. Default value is false.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- availability_
domain str - The availability domain of the desktop pool.
- availability_
policy desktops.Desktop Pool Availability Policy Args - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool. Use
availability_policy { }
to not set a schedule. - compartment_
id str - (Updatable) The OCID of the compartment which will contain the desktop pool.
- contact_
details str - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description str
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- device_
policy desktops.Desktop Pool Device Policy Args - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- display_
name str - (Updatable) A user friendly display name. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) 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"}
- image
desktops.
Desktop Pool Image Args - Provides information about the desktop image.
- is_
storage_ boolenabled - Indicates whether storage is enabled for the desktop pool.
- maximum_
size int - (Updatable) The maximum number of desktops permitted in the desktop pool.
- network_
configuration desktops.Desktop Pool Network Configuration Args - Provides information about the network configuration of the desktop pool.
- nsg_
ids Sequence[str] - A list of network security groups for the private access.
- private_
access_ desktops.details Desktop Pool Private Access Details Args - The details of the desktop's private access network connectivity to be set up for the desktop pool.
- session_
lifecycle_ desktops.actions Desktop Pool Session Lifecycle Actions Args - The details of action to be triggered in case of inactivity or disconnect
- shape_
config desktops.Desktop Pool Shape Config Args - The compute instance shape configuration requested for each desktop in the desktop pool.
- shape_
name str - The shape of the desktop pool.
- standby_
size int - (Updatable) The maximum number of standby desktops available in the desktop pool.
- state str
- The current state of the desktop pool.
- storage_
backup_ strpolicy_ id - The backup policy OCID of the storage.
- storage_
size_ intin_ gbs - The size in GBs of the storage for the desktop pool.
- time_
created str - The date and time the resource was created.
- time_
start_ strscheduled - (Updatable) The start time of the desktop pool.
- time_
stop_ strscheduled - (Updatable) The stop time of the desktop pool.
- use_
dedicated_ strvm_ host - Indicates whether the desktop pool uses dedicated virtual machine hosts.
- active
Desktops Number - The number of active desktops in the desktop pool.
- are
Privileged BooleanUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- are
Volumes BooleanPreserved (Updatable) Indicates whether the volumes are preserved when a desktop pool is deleted. Default value is false.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- availability
Domain String - The availability domain of the desktop pool.
- availability
Policy Property Map - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool. Use
availability_policy { }
to not set a schedule. - compartment
Id String - (Updatable) The OCID of the compartment which will contain the desktop pool.
- contact
Details String - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- device
Policy Property Map - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- display
Name String - (Updatable) A user friendly display name. Avoid entering confidential information.
- Map<String>
- (Updatable) 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"}
- image Property Map
- Provides information about the desktop image.
- is
Storage BooleanEnabled - Indicates whether storage is enabled for the desktop pool.
- maximum
Size Number - (Updatable) The maximum number of desktops permitted in the desktop pool.
- network
Configuration Property Map - Provides information about the network configuration of the desktop pool.
- nsg
Ids List<String> - A list of network security groups for the private access.
- private
Access Property MapDetails - The details of the desktop's private access network connectivity to be set up for the desktop pool.
- session
Lifecycle Property MapActions - The details of action to be triggered in case of inactivity or disconnect
- shape
Config Property Map - The compute instance shape configuration requested for each desktop in the desktop pool.
- shape
Name String - The shape of the desktop pool.
- standby
Size Number - (Updatable) The maximum number of standby desktops available in the desktop pool.
- state String
- The current state of the desktop pool.
- storage
Backup StringPolicy Id - The backup policy OCID of the storage.
- storage
Size NumberIn Gbs - The size in GBs of the storage for the desktop pool.
- time
Created String - The date and time the resource was created.
- time
Start StringScheduled - (Updatable) The start time of the desktop pool.
- time
Stop StringScheduled - (Updatable) The stop time of the desktop pool.
- use
Dedicated StringVm Host - Indicates whether the desktop pool uses dedicated virtual machine hosts.
Supporting Types
DesktopPoolAvailabilityPolicy, DesktopPoolAvailabilityPolicyArgs
- Start
Schedule DesktopPool Availability Policy Start Schedule - (Updatable) Provides the schedule information for a desktop.
- Stop
Schedule DesktopPool Availability Policy Stop Schedule - (Updatable) Provides the schedule information for a desktop.
- Start
Schedule DesktopPool Availability Policy Start Schedule - (Updatable) Provides the schedule information for a desktop.
- Stop
Schedule DesktopPool Availability Policy Stop Schedule - (Updatable) Provides the schedule information for a desktop.
- start
Schedule DesktopPool Availability Policy Start Schedule - (Updatable) Provides the schedule information for a desktop.
- stop
Schedule DesktopPool Availability Policy Stop Schedule - (Updatable) Provides the schedule information for a desktop.
- start
Schedule DesktopPool Availability Policy Start Schedule - (Updatable) Provides the schedule information for a desktop.
- stop
Schedule DesktopPool Availability Policy Stop Schedule - (Updatable) Provides the schedule information for a desktop.
- start_
schedule desktops.Desktop Pool Availability Policy Start Schedule - (Updatable) Provides the schedule information for a desktop.
- stop_
schedule desktops.Desktop Pool Availability Policy Stop Schedule - (Updatable) Provides the schedule information for a desktop.
- start
Schedule Property Map - (Updatable) Provides the schedule information for a desktop.
- stop
Schedule Property Map - (Updatable) Provides the schedule information for a desktop.
DesktopPoolAvailabilityPolicyStartSchedule, DesktopPoolAvailabilityPolicyStartScheduleArgs
- Cron
Expression string - (Updatable) A cron expression describing the desktop's schedule.
- Timezone string
- (Updatable) The timezone of the desktop's schedule.
- Cron
Expression string - (Updatable) A cron expression describing the desktop's schedule.
- Timezone string
- (Updatable) The timezone of the desktop's schedule.
- cron
Expression String - (Updatable) A cron expression describing the desktop's schedule.
- timezone String
- (Updatable) The timezone of the desktop's schedule.
- cron
Expression string - (Updatable) A cron expression describing the desktop's schedule.
- timezone string
- (Updatable) The timezone of the desktop's schedule.
- cron_
expression str - (Updatable) A cron expression describing the desktop's schedule.
- timezone str
- (Updatable) The timezone of the desktop's schedule.
- cron
Expression String - (Updatable) A cron expression describing the desktop's schedule.
- timezone String
- (Updatable) The timezone of the desktop's schedule.
DesktopPoolAvailabilityPolicyStopSchedule, DesktopPoolAvailabilityPolicyStopScheduleArgs
- Cron
Expression string - (Updatable) A cron expression describing the desktop's schedule.
- Timezone string
- (Updatable) The timezone of the desktop's schedule.
- Cron
Expression string - (Updatable) A cron expression describing the desktop's schedule.
- Timezone string
- (Updatable) The timezone of the desktop's schedule.
- cron
Expression String - (Updatable) A cron expression describing the desktop's schedule.
- timezone String
- (Updatable) The timezone of the desktop's schedule.
- cron
Expression string - (Updatable) A cron expression describing the desktop's schedule.
- timezone string
- (Updatable) The timezone of the desktop's schedule.
- cron_
expression str - (Updatable) A cron expression describing the desktop's schedule.
- timezone str
- (Updatable) The timezone of the desktop's schedule.
- cron
Expression String - (Updatable) A cron expression describing the desktop's schedule.
- timezone String
- (Updatable) The timezone of the desktop's schedule.
DesktopPoolDevicePolicy, DesktopPoolDevicePolicyArgs
- Audio
Mode string - (Updatable) The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop.
- Cdm
Mode string - (Updatable) The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop.
- Clipboard
Mode string - (Updatable) The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop.
- Is
Display boolEnabled - (Updatable) Indicates whether the display is enabled.
- Is
Keyboard boolEnabled - (Updatable) Indicates whether the keyboard is enabled.
- Is
Pointer boolEnabled - (Updatable) Indicates whether the pointer is enabled.
- Is
Printing boolEnabled - (Updatable) Indicates whether printing is enabled.
- Audio
Mode string - (Updatable) The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop.
- Cdm
Mode string - (Updatable) The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop.
- Clipboard
Mode string - (Updatable) The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop.
- Is
Display boolEnabled - (Updatable) Indicates whether the display is enabled.
- Is
Keyboard boolEnabled - (Updatable) Indicates whether the keyboard is enabled.
- Is
Pointer boolEnabled - (Updatable) Indicates whether the pointer is enabled.
- Is
Printing boolEnabled - (Updatable) Indicates whether printing is enabled.
- audio
Mode String - (Updatable) The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop.
- cdm
Mode String - (Updatable) The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop.
- clipboard
Mode String - (Updatable) The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop.
- is
Display BooleanEnabled - (Updatable) Indicates whether the display is enabled.
- is
Keyboard BooleanEnabled - (Updatable) Indicates whether the keyboard is enabled.
- is
Pointer BooleanEnabled - (Updatable) Indicates whether the pointer is enabled.
- is
Printing BooleanEnabled - (Updatable) Indicates whether printing is enabled.
- audio
Mode string - (Updatable) The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop.
- cdm
Mode string - (Updatable) The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop.
- clipboard
Mode string - (Updatable) The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop.
- is
Display booleanEnabled - (Updatable) Indicates whether the display is enabled.
- is
Keyboard booleanEnabled - (Updatable) Indicates whether the keyboard is enabled.
- is
Pointer booleanEnabled - (Updatable) Indicates whether the pointer is enabled.
- is
Printing booleanEnabled - (Updatable) Indicates whether printing is enabled.
- audio_
mode str - (Updatable) The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop.
- cdm_
mode str - (Updatable) The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop.
- clipboard_
mode str - (Updatable) The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop.
- is_
display_ boolenabled - (Updatable) Indicates whether the display is enabled.
- is_
keyboard_ boolenabled - (Updatable) Indicates whether the keyboard is enabled.
- is_
pointer_ boolenabled - (Updatable) Indicates whether the pointer is enabled.
- is_
printing_ boolenabled - (Updatable) Indicates whether printing is enabled.
- audio
Mode String - (Updatable) The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop.
- cdm
Mode String - (Updatable) The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop.
- clipboard
Mode String - (Updatable) The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop.
- is
Display BooleanEnabled - (Updatable) Indicates whether the display is enabled.
- is
Keyboard BooleanEnabled - (Updatable) Indicates whether the keyboard is enabled.
- is
Pointer BooleanEnabled - (Updatable) Indicates whether the pointer is enabled.
- is
Printing BooleanEnabled - (Updatable) Indicates whether printing is enabled.
DesktopPoolImage, DesktopPoolImageArgs
- Image
Id string - The OCID of the desktop image.
- Image
Name string - The name of the desktop image.
- Operating
System string - The operating system of the desktop image, e.g. "Oracle Linux", "Windows".
- Image
Id string - The OCID of the desktop image.
- Image
Name string - The name of the desktop image.
- Operating
System string - The operating system of the desktop image, e.g. "Oracle Linux", "Windows".
- image
Id String - The OCID of the desktop image.
- image
Name String - The name of the desktop image.
- operating
System String - The operating system of the desktop image, e.g. "Oracle Linux", "Windows".
- image
Id string - The OCID of the desktop image.
- image
Name string - The name of the desktop image.
- operating
System string - The operating system of the desktop image, e.g. "Oracle Linux", "Windows".
- image_
id str - The OCID of the desktop image.
- image_
name str - The name of the desktop image.
- operating_
system str - The operating system of the desktop image, e.g. "Oracle Linux", "Windows".
- image
Id String - The OCID of the desktop image.
- image
Name String - The name of the desktop image.
- operating
System String - The operating system of the desktop image, e.g. "Oracle Linux", "Windows".
DesktopPoolNetworkConfiguration, DesktopPoolNetworkConfigurationArgs
DesktopPoolPrivateAccessDetails, DesktopPoolPrivateAccessDetailsArgs
- Subnet
Id string - The OCID of the private subnet in the customer VCN where the connectivity will be established.
- Endpoint
Fqdn string - The three-label FQDN to use for the private endpoint. The customer VCN's DNS records are updated with this FQDN. This enables the customer to use the FQDN instead of the private endpoint's private IP address to access the service (for example, xyz.oraclecloud.com).
- Nsg
Ids List<string> - A list of network security groups for the private access.
- Private
Ip string - The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.
- Vcn
Id string - The OCID of the customer VCN.
- Subnet
Id string - The OCID of the private subnet in the customer VCN where the connectivity will be established.
- Endpoint
Fqdn string - The three-label FQDN to use for the private endpoint. The customer VCN's DNS records are updated with this FQDN. This enables the customer to use the FQDN instead of the private endpoint's private IP address to access the service (for example, xyz.oraclecloud.com).
- Nsg
Ids []string - A list of network security groups for the private access.
- Private
Ip string - The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.
- Vcn
Id string - The OCID of the customer VCN.
- subnet
Id String - The OCID of the private subnet in the customer VCN where the connectivity will be established.
- endpoint
Fqdn String - The three-label FQDN to use for the private endpoint. The customer VCN's DNS records are updated with this FQDN. This enables the customer to use the FQDN instead of the private endpoint's private IP address to access the service (for example, xyz.oraclecloud.com).
- nsg
Ids List<String> - A list of network security groups for the private access.
- private
Ip String - The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.
- vcn
Id String - The OCID of the customer VCN.
- subnet
Id string - The OCID of the private subnet in the customer VCN where the connectivity will be established.
- endpoint
Fqdn string - The three-label FQDN to use for the private endpoint. The customer VCN's DNS records are updated with this FQDN. This enables the customer to use the FQDN instead of the private endpoint's private IP address to access the service (for example, xyz.oraclecloud.com).
- nsg
Ids string[] - A list of network security groups for the private access.
- private
Ip string - The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.
- vcn
Id string - The OCID of the customer VCN.
- subnet_
id str - The OCID of the private subnet in the customer VCN where the connectivity will be established.
- endpoint_
fqdn str - The three-label FQDN to use for the private endpoint. The customer VCN's DNS records are updated with this FQDN. This enables the customer to use the FQDN instead of the private endpoint's private IP address to access the service (for example, xyz.oraclecloud.com).
- nsg_
ids Sequence[str] - A list of network security groups for the private access.
- private_
ip str - The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.
- vcn_
id str - The OCID of the customer VCN.
- subnet
Id String - The OCID of the private subnet in the customer VCN where the connectivity will be established.
- endpoint
Fqdn String - The three-label FQDN to use for the private endpoint. The customer VCN's DNS records are updated with this FQDN. This enables the customer to use the FQDN instead of the private endpoint's private IP address to access the service (for example, xyz.oraclecloud.com).
- nsg
Ids List<String> - A list of network security groups for the private access.
- private
Ip String - The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.
- vcn
Id String - The OCID of the customer VCN.
DesktopPoolSessionLifecycleActions, DesktopPoolSessionLifecycleActionsArgs
- Disconnect
Desktop
Pool Session Lifecycle Actions Disconnect - (Updatable) Action and grace period for disconnect. Session disconnect can not be used together with an
availability_policy
schedule. - Inactivity
Desktop
Pool Session Lifecycle Actions Inactivity - (Updatable) Action and grace period for inactivity
- Disconnect
Desktop
Pool Session Lifecycle Actions Disconnect - (Updatable) Action and grace period for disconnect. Session disconnect can not be used together with an
availability_policy
schedule. - Inactivity
Desktop
Pool Session Lifecycle Actions Inactivity - (Updatable) Action and grace period for inactivity
- disconnect
Desktop
Pool Session Lifecycle Actions Disconnect - (Updatable) Action and grace period for disconnect. Session disconnect can not be used together with an
availability_policy
schedule. - inactivity
Desktop
Pool Session Lifecycle Actions Inactivity - (Updatable) Action and grace period for inactivity
- disconnect
Desktop
Pool Session Lifecycle Actions Disconnect - (Updatable) Action and grace period for disconnect. Session disconnect can not be used together with an
availability_policy
schedule. - inactivity
Desktop
Pool Session Lifecycle Actions Inactivity - (Updatable) Action and grace period for inactivity
- disconnect
desktops.
Desktop Pool Session Lifecycle Actions Disconnect - (Updatable) Action and grace period for disconnect. Session disconnect can not be used together with an
availability_policy
schedule. - inactivity
desktops.
Desktop Pool Session Lifecycle Actions Inactivity - (Updatable) Action and grace period for inactivity
- disconnect Property Map
- (Updatable) Action and grace period for disconnect. Session disconnect can not be used together with an
availability_policy
schedule. - inactivity Property Map
- (Updatable) Action and grace period for inactivity
DesktopPoolSessionLifecycleActionsDisconnect, DesktopPoolSessionLifecycleActionsDisconnectArgs
- Action string
- (Updatable) a disconnect action to be triggered. Could be set to NONE or STOP
- Grace
Period intIn Minutes - (Updatable) The period of time (in minutes) after disconnect before any action occurs. If the value is not provided, a default value is used.
- Action string
- (Updatable) a disconnect action to be triggered. Could be set to NONE or STOP
- Grace
Period intIn Minutes - (Updatable) The period of time (in minutes) after disconnect before any action occurs. If the value is not provided, a default value is used.
- action String
- (Updatable) a disconnect action to be triggered. Could be set to NONE or STOP
- grace
Period IntegerIn Minutes - (Updatable) The period of time (in minutes) after disconnect before any action occurs. If the value is not provided, a default value is used.
- action string
- (Updatable) a disconnect action to be triggered. Could be set to NONE or STOP
- grace
Period numberIn Minutes - (Updatable) The period of time (in minutes) after disconnect before any action occurs. If the value is not provided, a default value is used.
- action str
- (Updatable) a disconnect action to be triggered. Could be set to NONE or STOP
- grace_
period_ intin_ minutes - (Updatable) The period of time (in minutes) after disconnect before any action occurs. If the value is not provided, a default value is used.
- action String
- (Updatable) a disconnect action to be triggered. Could be set to NONE or STOP
- grace
Period NumberIn Minutes - (Updatable) The period of time (in minutes) after disconnect before any action occurs. If the value is not provided, a default value is used.
DesktopPoolSessionLifecycleActionsInactivity, DesktopPoolSessionLifecycleActionsInactivityArgs
- Action string
- (Updatable) an inactivity action to be triggered. Could be set to NONE or DISCONNECT.
- Grace
Period intIn Minutes - (Updatable) The period of time (in minutes) during which the session must remain inactive before any action occurs. If the value is not provided, a default value is used.
- Action string
- (Updatable) an inactivity action to be triggered. Could be set to NONE or DISCONNECT.
- Grace
Period intIn Minutes - (Updatable) The period of time (in minutes) during which the session must remain inactive before any action occurs. If the value is not provided, a default value is used.
- action String
- (Updatable) an inactivity action to be triggered. Could be set to NONE or DISCONNECT.
- grace
Period IntegerIn Minutes - (Updatable) The period of time (in minutes) during which the session must remain inactive before any action occurs. If the value is not provided, a default value is used.
- action string
- (Updatable) an inactivity action to be triggered. Could be set to NONE or DISCONNECT.
- grace
Period numberIn Minutes - (Updatable) The period of time (in minutes) during which the session must remain inactive before any action occurs. If the value is not provided, a default value is used.
- action str
- (Updatable) an inactivity action to be triggered. Could be set to NONE or DISCONNECT.
- grace_
period_ intin_ minutes - (Updatable) The period of time (in minutes) during which the session must remain inactive before any action occurs. If the value is not provided, a default value is used.
- action String
- (Updatable) an inactivity action to be triggered. Could be set to NONE or DISCONNECT.
- grace
Period NumberIn Minutes - (Updatable) The period of time (in minutes) during which the session must remain inactive before any action occurs. If the value is not provided, a default value is used.
DesktopPoolShapeConfig, DesktopPoolShapeConfigArgs
- Baseline
Ocpu stringUtilization - The baseline OCPU utilization for a subcore burstable VM instance used for each desktop compute instance in the desktop pool. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with
BASELINE_1_1
. The following values are supported:BASELINE_1_8
- baseline usage is 1/8 of an OCPU.BASELINE_1_2
- baseline usage is 1/2 of an OCPU.BASELINE_1_1
- baseline usage is the entire OCPU. This represents a non-burstable instance.
- Memory
In stringGbs - The total amount of memory available in gigabytes for each desktop compute instance in the desktop pool.
- Ocpus string
- The total number of OCPUs available for each desktop compute instance in the desktop pool.
- Baseline
Ocpu stringUtilization - The baseline OCPU utilization for a subcore burstable VM instance used for each desktop compute instance in the desktop pool. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with
BASELINE_1_1
. The following values are supported:BASELINE_1_8
- baseline usage is 1/8 of an OCPU.BASELINE_1_2
- baseline usage is 1/2 of an OCPU.BASELINE_1_1
- baseline usage is the entire OCPU. This represents a non-burstable instance.
- Memory
In stringGbs - The total amount of memory available in gigabytes for each desktop compute instance in the desktop pool.
- Ocpus string
- The total number of OCPUs available for each desktop compute instance in the desktop pool.
- baseline
Ocpu StringUtilization - The baseline OCPU utilization for a subcore burstable VM instance used for each desktop compute instance in the desktop pool. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with
BASELINE_1_1
. The following values are supported:BASELINE_1_8
- baseline usage is 1/8 of an OCPU.BASELINE_1_2
- baseline usage is 1/2 of an OCPU.BASELINE_1_1
- baseline usage is the entire OCPU. This represents a non-burstable instance.
- memory
In StringGbs - The total amount of memory available in gigabytes for each desktop compute instance in the desktop pool.
- ocpus String
- The total number of OCPUs available for each desktop compute instance in the desktop pool.
- baseline
Ocpu stringUtilization - The baseline OCPU utilization for a subcore burstable VM instance used for each desktop compute instance in the desktop pool. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with
BASELINE_1_1
. The following values are supported:BASELINE_1_8
- baseline usage is 1/8 of an OCPU.BASELINE_1_2
- baseline usage is 1/2 of an OCPU.BASELINE_1_1
- baseline usage is the entire OCPU. This represents a non-burstable instance.
- memory
In stringGbs - The total amount of memory available in gigabytes for each desktop compute instance in the desktop pool.
- ocpus string
- The total number of OCPUs available for each desktop compute instance in the desktop pool.
- baseline_
ocpu_ strutilization - The baseline OCPU utilization for a subcore burstable VM instance used for each desktop compute instance in the desktop pool. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with
BASELINE_1_1
. The following values are supported:BASELINE_1_8
- baseline usage is 1/8 of an OCPU.BASELINE_1_2
- baseline usage is 1/2 of an OCPU.BASELINE_1_1
- baseline usage is the entire OCPU. This represents a non-burstable instance.
- memory_
in_ strgbs - The total amount of memory available in gigabytes for each desktop compute instance in the desktop pool.
- ocpus str
- The total number of OCPUs available for each desktop compute instance in the desktop pool.
- baseline
Ocpu StringUtilization - The baseline OCPU utilization for a subcore burstable VM instance used for each desktop compute instance in the desktop pool. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with
BASELINE_1_1
. The following values are supported:BASELINE_1_8
- baseline usage is 1/8 of an OCPU.BASELINE_1_2
- baseline usage is 1/2 of an OCPU.BASELINE_1_1
- baseline usage is the entire OCPU. This represents a non-burstable instance.
- memory
In StringGbs - The total amount of memory available in gigabytes for each desktop compute instance in the desktop pool.
- ocpus String
- The total number of OCPUs available for each desktop compute instance in the desktop pool.
Import
DesktopPools can be imported using the id
, e.g.
$ pulumi import oci:Desktops/desktopPool:DesktopPool test_desktop_pool "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.