Amazonka.WorkSpaces.Types.WorkspaceProperties

Documentation

data WorkspaceProperties

Describes a WorkSpace.

See: newWorkspaceProperties smart constructor.

Constructors

WorkspaceProperties'

Fields

• computeTypeName :: Maybe Compute

  The compute type. For more information, see Amazon WorkSpaces Bundles.

• protocols :: Maybe [Protocol]

  The protocol. For more information, see Protocols for Amazon WorkSpaces.

  • Only available for WorkSpaces created with PCoIP bundles.
  • The Protocols property is case sensitive. Ensure you use PCOIP or WSP.
  • Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
• rootVolumeSizeGib :: Maybe Int

  The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

• runningMode :: Maybe RunningMode

  The running mode. For more information, see Manage the WorkSpace Running Mode.

  The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

• runningModeAutoStopTimeoutInMinutes :: Maybe Int

  The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

• userVolumeSizeGib :: Maybe Int

  The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

Instances

FromJSON WorkspaceProperties

Defined in Amazonka.WorkSpaces.Types.WorkspaceProperties

Methods

parseJSON :: Value -> Parser WorkspaceProperties

parseJSONList :: Value -> Parser [WorkspaceProperties]

ToJSON WorkspaceProperties

Defined in Amazonka.WorkSpaces.Types.WorkspaceProperties

Methods

toJSON :: WorkspaceProperties -> Value

toEncoding :: WorkspaceProperties -> Encoding

toJSONList :: [WorkspaceProperties] -> Value

toEncodingList :: [WorkspaceProperties] -> Encoding

Generic WorkspaceProperties

Defined in Amazonka.WorkSpaces.Types.WorkspaceProperties

Associated Types

type Rep WorkspaceProperties :: Type -> Type

Methods

from :: WorkspaceProperties -> Rep WorkspaceProperties x

to :: Rep WorkspaceProperties x -> WorkspaceProperties

Read WorkspaceProperties

Defined in Amazonka.WorkSpaces.Types.WorkspaceProperties

Methods

readsPrec :: Int -> ReadS WorkspaceProperties

readList :: ReadS [WorkspaceProperties]

readPrec :: ReadPrec WorkspaceProperties

readListPrec :: ReadPrec [WorkspaceProperties]

Show WorkspaceProperties

Defined in Amazonka.WorkSpaces.Types.WorkspaceProperties

Methods

showsPrec :: Int -> WorkspaceProperties -> ShowS

show :: WorkspaceProperties -> String

showList :: [WorkspaceProperties] -> ShowS

NFData WorkspaceProperties

Defined in Amazonka.WorkSpaces.Types.WorkspaceProperties

Methods

rnf :: WorkspaceProperties -> ()

Eq WorkspaceProperties

Defined in Amazonka.WorkSpaces.Types.WorkspaceProperties

Methods

(==) :: WorkspaceProperties -> WorkspaceProperties -> Bool

(/=) :: WorkspaceProperties -> WorkspaceProperties -> Bool

Hashable WorkspaceProperties

Defined in Amazonka.WorkSpaces.Types.WorkspaceProperties

Methods

hashWithSalt :: Int -> WorkspaceProperties -> Int

hash :: WorkspaceProperties -> Int

type Rep WorkspaceProperties

Defined in Amazonka.WorkSpaces.Types.WorkspaceProperties

type Rep WorkspaceProperties = D1 ('MetaData "WorkspaceProperties" "Amazonka.WorkSpaces.Types.WorkspaceProperties" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "WorkspaceProperties'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "computeTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Compute)) :*: (S1 ('MetaSel ('Just "protocols") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Protocol])) :*: S1 ('MetaSel ('Just "rootVolumeSizeGib") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "runningMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RunningMode)) :*: (S1 ('MetaSel ('Just "runningModeAutoStopTimeoutInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "userVolumeSizeGib") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newWorkspaceProperties :: WorkspaceProperties

Create a value of WorkspaceProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:computeTypeName:WorkspaceProperties', workspaceProperties_computeTypeName - The compute type. For more information, see Amazon WorkSpaces Bundles.

$sel:protocols:WorkspaceProperties', workspaceProperties_protocols - The protocol. For more information, see Protocols for Amazon WorkSpaces.

• Only available for WorkSpaces created with PCoIP bundles.
• The Protocols property is case sensitive. Ensure you use PCOIP or WSP.
• Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

$sel:rootVolumeSizeGib:WorkspaceProperties', workspaceProperties_rootVolumeSizeGib - The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

$sel:runningMode:WorkspaceProperties', workspaceProperties_runningMode - The running mode. For more information, see Manage the WorkSpace Running Mode.

The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

$sel:runningModeAutoStopTimeoutInMinutes:WorkspaceProperties', workspaceProperties_runningModeAutoStopTimeoutInMinutes - The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

$sel:userVolumeSizeGib:WorkspaceProperties', workspaceProperties_userVolumeSizeGib - The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

workspaceProperties_computeTypeName :: Lens' WorkspaceProperties (Maybe Compute)

The compute type. For more information, see Amazon WorkSpaces Bundles.

workspaceProperties_protocols :: Lens' WorkspaceProperties (Maybe [Protocol])

The protocol. For more information, see Protocols for Amazon WorkSpaces.

• Only available for WorkSpaces created with PCoIP bundles.
• The Protocols property is case sensitive. Ensure you use PCOIP or WSP.
• Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

workspaceProperties_rootVolumeSizeGib :: Lens' WorkspaceProperties (Maybe Int)

The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

workspaceProperties_runningMode :: Lens' WorkspaceProperties (Maybe RunningMode)

The running mode. For more information, see Manage the WorkSpace Running Mode.

The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

workspaceProperties_runningModeAutoStopTimeoutInMinutes :: Lens' WorkspaceProperties (Maybe Int)

The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

workspaceProperties_userVolumeSizeGib :: Lens' WorkspaceProperties (Maybe Int)

The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.