Skip to content

Latest commit

 

History

History
213 lines (177 loc) · 8.06 KB

quickcreate_aws_workspaces_deployment.md

File metadata and controls

213 lines (177 loc) · 8.06 KB
page_title subcategory description
citrix_quickcreate_aws_workspaces_deployment Resource - citrix
DaaS Quick Deploy - AWS WorkSpaces Core
Manages an AWS WorkSpaces deployment.

citrix_quickcreate_aws_workspaces_deployment (Resource)

Manages an AWS WorkSpaces deployment.

Example Usage

# User coupled workspaces with MANUAL running mode
resource "citrix_quickcreate_aws_workspaces_deployment" "example_qcs_deployment" {
    name                    = "example-aws-workspaces-deployment"
    account_id              = citrix_quickcreate_aws_workspaces_account.example_aws_workspaces_account.id
    directory_connection_id = citrix_quickcreate_aws_workspaces_directory_connection.example_directory_connection.id
    image_id                = citrix_quickcreate_aws_workspaces_image.example_image.id
    performance             = "STANDARD"
    root_volume_size        = "80"
    user_volume_size        = "50"
    volumes_encrypted       = true
    volumes_encryption_key  = "alias/aws/workspaces"

    running_mode = "MANUAL"
    scale_settings = {
        disconnect_session_idle_timeout = 5
        shutdown_disconnect_timeout = 15
        shutdown_log_off_timeout = 15
        buffer_capacity_size_percentage = 0
    }

    user_decoupled_workspaces = false
    workspaces = [
        {
            username = "user0001"
            root_volume_size = 80
            user_volume_size = 50
            maintenance_mode = false
        },
        {
            username = "user0002"
            root_volume_size = 80
            user_volume_size = 50
            maintenance_mode = true
        },
    ]
}

# User coupled workspaces with ALWAYS_ON running mode
resource "citrix_quickcreate_aws_workspaces_deployment" "example_qcs_deployment" {
    name                    = "example-aws-workspaces-deployment"
    account_id              = citrix_quickcreate_aws_workspaces_account.example_aws_workspaces_account.id
    directory_connection_id = citrix_quickcreate_aws_workspaces_directory_connection.example_directory_connection.id
    image_id                = citrix_quickcreate_aws_workspaces_image.example_image.id
    performance             = "STANDARD"
    root_volume_size        = "80"
    user_volume_size        = "50"
    volumes_encrypted       = true
    volumes_encryption_key  = "alias/aws/workspaces"

    running_mode = "ALWAYS_ON"

    user_decoupled_workspaces = false
    workspaces = [
        {
            username = "user0001"
            root_volume_size = 80
            user_volume_size = 50
            maintenance_mode = false
        },
        {
            username = "user0002"
            root_volume_size = 80
            user_volume_size = 50
            maintenance_mode = true
        },
    ]
}

# User decoupled workspaces with MANUAL running mode
resource "citrix_quickcreate_aws_workspaces_deployment" "example_qcs_deployment" {
    name                    = "example-aws-workspaces-deployment"
    account_id              = citrix_quickcreate_aws_workspaces_account.example_aws_workspaces_account.id
    directory_connection_id = citrix_quickcreate_aws_workspaces_directory_connection.example_directory_connection.id
    image_id                = citrix_quickcreate_aws_workspaces_image.example_image.id
    performance             = "STANDARD"
    root_volume_size        = "80"
    user_volume_size        = "50"
    volumes_encrypted       = true
    volumes_encryption_key  = "alias/aws/workspaces"

    running_mode            = "MANUAL"
    scale_settings = {
        disconnect_session_idle_timeout = 5
        shutdown_disconnect_timeout = 15
        shutdown_log_off_timeout = 15
        buffer_capacity_size_percentage = 0
    }

    user_decoupled_workspaces = true
    workspaces = [
        {
            root_volume_size = 80
            user_volume_size = 50
            maintenance_mode = false
        },
        {
            root_volume_size = 80
            user_volume_size = 50
            maintenance_mode = true
        },
    ]
}

# User decoupled workspaces with ALWAYS_ON running mode
resource "citrix_quickcreate_aws_workspaces_deployment" "example_qcs_deployment" {
    name                    = "example-aws-workspaces-deployment"
    account_id              = citrix_quickcreate_aws_workspaces_account.example_aws_workspaces_account.id
    directory_connection_id = citrix_quickcreate_aws_workspaces_directory_connection.example_directory_connection.id
    image_id                = citrix_quickcreate_aws_workspaces_image.example_image.id
    performance             = "STANDARD"
    root_volume_size        = "80"
    user_volume_size        = "50"
    volumes_encrypted       = true
    volumes_encryption_key  = "alias/aws/workspaces"

    running_mode = "ALWAYS_ON"

    user_decoupled_workspaces = true
    workspaces = [
        {
            root_volume_size = 80
            user_volume_size = 50
            maintenance_mode = false
        },
        {
            root_volume_size = 80
            user_volume_size = 50
            maintenance_mode = true
        },
    ]
}

Schema

Required

  • account_id (String) GUID of the account.
  • directory_connection_id (String) GUID of the directory.
  • image_id (String) GUID of the image.
  • name (String) Name of the deployment.
  • performance (String) Performance of the workspace. Possible Values are VALUE, STANDARD, PERFORMANCE, POWER, POWERPRO, GRAPHICS, GRAPHICSPRO.
  • root_volume_size (Number) Size of the root volume in GB. Possible Values are 80 or any integer between 175 and 2000 (inclusive).
  • running_mode (String) Running mode of the workspace. Possible Values are ALWAYS_ON and MANUAL.
  • user_decoupled_workspaces (Boolean) Indicates if the user decoupled workspaces are enabled.
  • user_volume_size (Number) Size of the user volume in GB. Possible Values are 10, 50, or any integer between 100 and 2000 (inclusive).
  • volumes_encrypted (Boolean) Indicates if the volumes are encrypted.

Optional

  • scale_settings (Attributes) Manual power management configuration for the deployment. (see below for nested schema)
  • volumes_encryption_key (String) AWS KMS key to be used for workspace encryption. Use alias/aws/workspaces for default AWS KMS workspace encryption key.
  • workspaces (Attributes List) Set of workspaces with assigned users. (see below for nested schema)

Read-Only

  • id (String) GUID identifier of the deployment.

Nested Schema for scale_settings

Optional:

  • buffer_capacity_size_percentage (Number) Indicates buffer capacity size. Defaults to 0.
  • disconnect_session_idle_timeout (Number) Indicates timespan before disconnect sessions that are idle in minutes. Defaults to 15.
  • shutdown_disconnect_timeout (Number) Indicates timespan before shut down desktops with disconnected sessions in minutes. Defaults to 15.
  • shutdown_log_off_timeout (Number) Indicates timespan before shut down desktops after sign-out in minutes. Defaults to 5.

Nested Schema for workspaces

Required:

  • root_volume_size (Number) Indicates the root volume size of the workspace.
  • user_volume_size (Number) Indicates the user volume size of the workspace.

Optional:

  • maintenance_mode (Boolean) Indicates if the workspace will be set to maintenance mode.
  • username (String) Username of the user to be assigned to this workspace. Required if user_decoupled_workspaces is set to false.

Read-Only:

  • broker_machine_id (String) GUID identifier of the machine.
  • machine_id (String) Id of the machine.
  • machine_name (String) Name of the machine.
  • workspace_id (String) Id of the AWS WorkSpaces machine.

Import

Import is supported using the following syntax:

# Quick Deploy AWS WorkSpaces Deployment can be imported by specifying the Deployment GUID.
terraform import citrix_quickcreate_aws_workspaces_deployment.example_aws_workspaces_deployment 00000000-0000-0000-0000-000000000000