Class: AWSCDK::Workspaces::CfnWorkspace::WorkspacePropertiesProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
workspaces/cfn_workspace.rb

Overview

Information about a WorkSpace.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(compute_type_name: nil, root_volume_size_gib: nil, running_mode: nil, running_mode_auto_stop_timeout_in_minutes: nil, user_volume_size_gib: nil) ⇒ WorkspacePropertiesProperty

Returns a new instance of WorkspacePropertiesProperty.

Parameters:

  • compute_type_name (String, nil) (defaults to: nil) —

    The compute type.

  • root_volume_size_gib (Numeric, nil) (defaults to: nil) —

    The size of the root volume.

  • running_mode (String, nil) (defaults to: nil) —

    The running mode.

  • running_mode_auto_stop_timeout_in_minutes (Numeric, nil) (defaults to: nil) —

    The time after a user logs off when WorkSpaces are automatically stopped.

  • user_volume_size_gib (Numeric, nil) (defaults to: nil) —

    The size of the user storage.



634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'workspaces/cfn_workspace.rb', line 634

def initialize(compute_type_name: nil, root_volume_size_gib: nil, running_mode: nil, running_mode_auto_stop_timeout_in_minutes: nil, user_volume_size_gib: nil)
  @compute_type_name = compute_type_name
  Jsii::Type.check_type(@compute_type_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "computeTypeName") unless @compute_type_name.nil?
  @root_volume_size_gib = root_volume_size_gib
  Jsii::Type.check_type(@root_volume_size_gib, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "rootVolumeSizeGib") unless @root_volume_size_gib.nil?
  @running_mode = running_mode
  Jsii::Type.check_type(@running_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "runningMode") unless @running_mode.nil?
  @running_mode_auto_stop_timeout_in_minutes = running_mode_auto_stop_timeout_in_minutes
  Jsii::Type.check_type(@running_mode_auto_stop_timeout_in_minutes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "runningModeAutoStopTimeoutInMinutes") unless @running_mode_auto_stop_timeout_in_minutes.nil?
  @user_volume_size_gib = user_volume_size_gib
  Jsii::Type.check_type(@user_volume_size_gib, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "userVolumeSizeGib") unless @user_volume_size_gib.nil?
end

Instance Attribute Details

#compute_type_name ⇒ String? (readonly)

The compute type.

For more information, see Amazon WorkSpaces Bundles .

Returns:

  • (String, nil)

See Also:



653
654
655
 
# File 'workspaces/cfn_workspace.rb', line 653

def compute_type_name
  @compute_type_name
end

#root_volume_size_gib ⇒ Numeric? (readonly)

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 .

Returns:

  • (Numeric, nil)

See Also:



660
661
662
 
# File 'workspaces/cfn_workspace.rb', line 660

def root_volume_size_gib
  @root_volume_size_gib
end

#running_mode ⇒ String? (readonly)

The running mode.

For more information, see Manage the WorkSpace Running Mode .

Returns:

  • (String, nil)

See Also:



667
668
669
 
# File 'workspaces/cfn_workspace.rb', line 667

def running_mode
  @running_mode
end

#running_mode_auto_stop_timeout_in_minutes ⇒ Numeric? (readonly)

The time after a user logs off when WorkSpaces are automatically stopped.

Configured in 60-minute intervals.

Returns:

  • (Numeric, nil)

See Also:



674
675
676
 
# File 'workspaces/cfn_workspace.rb', line 674

def running_mode_auto_stop_timeout_in_minutes
  @running_mode_auto_stop_timeout_in_minutes
end

#user_volume_size_gib ⇒ Numeric? (readonly)

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 .

Returns:

  • (Numeric, nil)

See Also:



681
682
683
 
# File 'workspaces/cfn_workspace.rb', line 681

def user_volume_size_gib
  @user_volume_size_gib
end

Class Method Details

.jsii_properties ⇒ Object 



683
684
685
686
687
688
689
690
691
 
# File 'workspaces/cfn_workspace.rb', line 683

def self.jsii_properties
  {
    :compute_type_name => "computeTypeName",
    :root_volume_size_gib => "rootVolumeSizeGib",
    :running_mode => "runningMode",
    :running_mode_auto_stop_timeout_in_minutes => "runningModeAutoStopTimeoutInMinutes",
    :user_volume_size_gib => "userVolumeSizeGib",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



693
694
695
696
697
698
699
700
701
702
703
 
# File 'workspaces/cfn_workspace.rb', line 693

def to_jsii
  result = {}
  result.merge!({
    "computeTypeName" => @compute_type_name,
    "rootVolumeSizeGib" => @root_volume_size_gib,
    "runningMode" => @running_mode,
    "runningModeAutoStopTimeoutInMinutes" => @running_mode_auto_stop_timeout_in_minutes,
    "userVolumeSizeGib" => @user_volume_size_gib,
  })
  result.compact
end