Class: AWSCDK::Workspaces::CfnWorkspacesPoolProps

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

Overview

Properties for defining a CfnWorkspacesPool.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bundle_id:, capacity:, directory_id:, pool_name:, application_settings: nil, description: nil, running_mode: nil, tags: nil, timeout_settings: nil) ⇒ CfnWorkspacesPoolProps

Returns a new instance of CfnWorkspacesPoolProps.

Parameters:



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'workspaces/cfn_workspaces_pool_props.rb', line 18

def initialize(bundle_id:, capacity:, directory_id:, pool_name:, application_settings: nil, description: nil, running_mode: nil, tags: nil, timeout_settings: nil)
  @bundle_id = bundle_id
  Jsii::Type.check_type(@bundle_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bundleId")
  @capacity = capacity.is_a?(Hash) ? ::AWSCDK::Workspaces::CfnWorkspacesPool::CapacityProperty.new(**capacity.transform_keys(&:to_sym)) : capacity
  Jsii::Type.check_type(@capacity, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193b3Jrc3BhY2VzLkNmbldvcmtzcGFjZXNQb29sLkNhcGFjaXR5UHJvcGVydHkifV19fQ==")), "capacity")
  @directory_id = directory_id
  Jsii::Type.check_type(@directory_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "directoryId")
  @pool_name = pool_name
  Jsii::Type.check_type(@pool_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "poolName")
  @application_settings = application_settings.is_a?(Hash) ? ::AWSCDK::Workspaces::CfnWorkspacesPool::ApplicationSettingsProperty.new(**application_settings.transform_keys(&:to_sym)) : application_settings
  Jsii::Type.check_type(@application_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193b3Jrc3BhY2VzLkNmbldvcmtzcGFjZXNQb29sLkFwcGxpY2F0aW9uU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "applicationSettings") unless @application_settings.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @running_mode = running_mode
  Jsii::Type.check_type(@running_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "runningMode") unless @running_mode.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @timeout_settings = timeout_settings.is_a?(Hash) ? ::AWSCDK::Workspaces::CfnWorkspacesPool::TimeoutSettingsProperty.new(**timeout_settings.transform_keys(&:to_sym)) : timeout_settings
  Jsii::Type.check_type(@timeout_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193b3Jrc3BhY2VzLkNmbldvcmtzcGFjZXNQb29sLlRpbWVvdXRTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "timeoutSettings") unless @timeout_settings.nil?
end

Instance Attribute Details

#application_settings ⇒ AWSCDK::IResolvable, ... (readonly)

The persistent application settings for users of the pool.

Returns:

See Also:



63
64
65
 
# File 'workspaces/cfn_workspaces_pool_props.rb', line 63

def application_settings
  @application_settings
end

#bundle_id ⇒ String (readonly)

The identifier of the bundle used by the pool.

Returns:

  • (String)

See Also:



43
44
45
 
# File 'workspaces/cfn_workspaces_pool_props.rb', line 43

def bundle_id
  @bundle_id
end

#capacity ⇒ AWSCDK::IResolvable, AWSCDK::Workspaces::CfnWorkspacesPool::CapacityProperty (readonly)

Describes the user capacity for the pool.

Returns:

See Also:



48
49
50
 
# File 'workspaces/cfn_workspaces_pool_props.rb', line 48

def capacity
  @capacity
end

#description ⇒ String? (readonly)

The description of the pool.

Returns:

  • (String, nil)

See Also:



68
69
70
 
# File 'workspaces/cfn_workspaces_pool_props.rb', line 68

def description
  @description
end

#directory_id ⇒ String (readonly)

The identifier of the directory used by the pool.

Returns:

  • (String)

See Also:



53
54
55
 
# File 'workspaces/cfn_workspaces_pool_props.rb', line 53

def directory_id
  @directory_id
end

#pool_name ⇒ String (readonly)

The name of the pool.

Returns:

  • (String)

See Also:



58
59
60
 
# File 'workspaces/cfn_workspaces_pool_props.rb', line 58

def pool_name
  @pool_name
end

#running_mode ⇒ String? (readonly)

The running mode of the pool.

Returns:

  • (String, nil)

See Also:



73
74
75
 
# File 'workspaces/cfn_workspaces_pool_props.rb', line 73

def running_mode
  @running_mode
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Deprecated.

this property has been deprecated

Returns:

See Also:



77
78
79
 
# File 'workspaces/cfn_workspaces_pool_props.rb', line 77

def tags
  @tags
end

#timeout_settings ⇒ AWSCDK::IResolvable, ... (readonly)

The amount of time that a pool session remains active after users disconnect.

If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.

Returns:

See Also:



84
85
86
 
# File 'workspaces/cfn_workspaces_pool_props.rb', line 84

def timeout_settings
  @timeout_settings
end

Class Method Details

.jsii_properties ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'workspaces/cfn_workspaces_pool_props.rb', line 86

def self.jsii_properties
  {
    :bundle_id => "bundleId",
    :capacity => "capacity",
    :directory_id => "directoryId",
    :pool_name => "poolName",
    :application_settings => "applicationSettings",
    :description => "description",
    :running_mode => "runningMode",
    :tags => "tags",
    :timeout_settings => "timeoutSettings",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'workspaces/cfn_workspaces_pool_props.rb', line 100

def to_jsii
  result = {}
  result.merge!({
    "bundleId" => @bundle_id,
    "capacity" => @capacity,
    "directoryId" => @directory_id,
    "poolName" => @pool_name,
    "applicationSettings" => @application_settings,
    "description" => @description,
    "runningMode" => @running_mode,
    "tags" => @tags,
    "timeoutSettings" => @timeout_settings,
  })
  result.compact
end