Class: AWSCDK::AppStream::CfnFleetProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_stream/cfn_fleet_props.rb

Overview

Properties for defining a CfnFleet.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instance_type:, name:, compute_capacity: nil, description: nil, disable_imdsv1: nil, disconnect_timeout_in_seconds: nil, display_name: nil, domain_join_info: nil, enable_default_internet_access: nil, fleet_type: nil, iam_role_arn: nil, idle_disconnect_timeout_in_seconds: nil, image_arn: nil, image_name: nil, max_concurrent_sessions: nil, max_sessions_per_instance: nil, max_user_duration_in_seconds: nil, platform: nil, root_volume_config: nil, session_script_s3_location: nil, stream_view: nil, tags: nil, usb_device_filter_strings: nil, vpc_config: nil) ⇒ CfnFleetProps

Returns a new instance of CfnFleetProps.

Parameters:

  • instance_type (String) —

    The instance type to use when launching fleet instances. The following instance types are available for non-Elastic fleets:.

  • name (String) —

    A unique name for the fleet.

  • compute_capacity (AWSCDK::IResolvable, AWSCDK::AppStream::CfnFleet::ComputeCapacityProperty, nil) (defaults to: nil) —

    The desired capacity for the fleet.

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

    The description to display.

  • disable_imdsv1 (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil)
  • disconnect_timeout_in_seconds (Numeric, nil) (defaults to: nil) —

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

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

    The fleet name to display.

  • domain_join_info (AWSCDK::IResolvable, AWSCDK::AppStream::CfnFleet::DomainJoinInfoProperty, nil) (defaults to: nil) —

    The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

  • enable_default_internet_access (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Enables or disables default internet access for the fleet.

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

    The fleet type.

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

    The ARN of the IAM role that is applied to the fleet.

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

    The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins.

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

    The ARN of the public, private, or shared image to use.

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

    The name of the image used to create the fleet.

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

    The maximum number of concurrent sessions that can be run on an Elastic fleet.

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

    Max number of user sessions on an instance.

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

    The maximum amount of time that a streaming session can remain active, in seconds.

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

    The platform of the fleet.

  • root_volume_config (AWSCDK::IResolvable, AWSCDK::AppStream::CfnFleet::VolumeConfigProperty, nil) (defaults to: nil)
  • session_script_s3_location (AWSCDK::IResolvable, AWSCDK::AppStream::CfnFleet::S3LocationProperty, nil) (defaults to: nil) —

    The S3 location of the session scripts configuration zip file.

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

    The WorkSpaces Applications view that is displayed to your users when they stream from the fleet.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An array of key-value pairs.

  • usb_device_filter_strings (Array<String>, nil) (defaults to: nil) —

    The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client.

  • vpc_config (AWSCDK::IResolvable, AWSCDK::AppStream::CfnFleet::VPCConfigProperty, nil) (defaults to: nil) —

    The VPC configuration for the fleet.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'app_stream/cfn_fleet_props.rb', line 33

def initialize(instance_type:, name:, compute_capacity: nil, description: nil, disable_imdsv1: nil, disconnect_timeout_in_seconds: nil, display_name: nil, domain_join_info: nil, enable_default_internet_access: nil, fleet_type: nil, iam_role_arn: nil, idle_disconnect_timeout_in_seconds: nil, image_arn: nil, image_name: nil, max_concurrent_sessions: nil, max_sessions_per_instance: nil, max_user_duration_in_seconds: nil, platform: nil, root_volume_config: nil, session_script_s3_location: nil, stream_view: nil, tags: nil, usb_device_filter_strings: nil, vpc_config: nil)
  @instance_type = instance_type
  Jsii::Type.check_type(@instance_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceType")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @compute_capacity = compute_capacity.is_a?(Hash) ? ::AWSCDK::AppStream::CfnFleet::ComputeCapacityProperty.new(**compute_capacity.transform_keys(&:to_sym)) : compute_capacity
  Jsii::Type.check_type(@compute_capacity, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuRmxlZXQuQ29tcHV0ZUNhcGFjaXR5UHJvcGVydHkifV19fQ==")), "computeCapacity") unless @compute_capacity.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @disable_imdsv1 = disable_imdsv1
  Jsii::Type.check_type(@disable_imdsv1, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "disableImdsv1") unless @disable_imdsv1.nil?
  @disconnect_timeout_in_seconds = disconnect_timeout_in_seconds
  Jsii::Type.check_type(@disconnect_timeout_in_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "disconnectTimeoutInSeconds") unless @disconnect_timeout_in_seconds.nil?
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName") unless @display_name.nil?
  @domain_join_info = domain_join_info.is_a?(Hash) ? ::AWSCDK::AppStream::CfnFleet::DomainJoinInfoProperty.new(**domain_join_info.transform_keys(&:to_sym)) : domain_join_info
  Jsii::Type.check_type(@domain_join_info, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuRmxlZXQuRG9tYWluSm9pbkluZm9Qcm9wZXJ0eSJ9XX19")), "domainJoinInfo") unless @domain_join_info.nil?
  @enable_default_internet_access = enable_default_internet_access
  Jsii::Type.check_type(@enable_default_internet_access, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableDefaultInternetAccess") unless @enable_default_internet_access.nil?
  @fleet_type = fleet_type
  Jsii::Type.check_type(@fleet_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fleetType") unless @fleet_type.nil?
  @iam_role_arn = iam_role_arn
  Jsii::Type.check_type(@iam_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "iamRoleArn") unless @iam_role_arn.nil?
  @idle_disconnect_timeout_in_seconds = idle_disconnect_timeout_in_seconds
  Jsii::Type.check_type(@idle_disconnect_timeout_in_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "idleDisconnectTimeoutInSeconds") unless @idle_disconnect_timeout_in_seconds.nil?
  @image_arn = image_arn
  Jsii::Type.check_type(@image_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "imageArn") unless @image_arn.nil?
  @image_name = image_name
  Jsii::Type.check_type(@image_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "imageName") unless @image_name.nil?
  @max_concurrent_sessions = max_concurrent_sessions
  Jsii::Type.check_type(@max_concurrent_sessions, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxConcurrentSessions") unless @max_concurrent_sessions.nil?
  @max_sessions_per_instance = max_sessions_per_instance
  Jsii::Type.check_type(@max_sessions_per_instance, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxSessionsPerInstance") unless @max_sessions_per_instance.nil?
  @max_user_duration_in_seconds = max_user_duration_in_seconds
  Jsii::Type.check_type(@max_user_duration_in_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxUserDurationInSeconds") unless @max_user_duration_in_seconds.nil?
  @platform = platform
  Jsii::Type.check_type(@platform, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "platform") unless @platform.nil?
  @root_volume_config = root_volume_config.is_a?(Hash) ? ::AWSCDK::AppStream::CfnFleet::VolumeConfigProperty.new(**root_volume_config.transform_keys(&:to_sym)) : root_volume_config
  Jsii::Type.check_type(@root_volume_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuRmxlZXQuVm9sdW1lQ29uZmlnUHJvcGVydHkifV19fQ==")), "rootVolumeConfig") unless @root_volume_config.nil?
  @session_script_s3_location = session_script_s3_location.is_a?(Hash) ? ::AWSCDK::AppStream::CfnFleet::S3LocationProperty.new(**session_script_s3_location.transform_keys(&:to_sym)) : session_script_s3_location
  Jsii::Type.check_type(@session_script_s3_location, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuRmxlZXQuUzNMb2NhdGlvblByb3BlcnR5In1dfX0=")), "sessionScriptS3Location") unless @session_script_s3_location.nil?
  @stream_view = stream_view
  Jsii::Type.check_type(@stream_view, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "streamView") unless @stream_view.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?
  @usb_device_filter_strings = usb_device_filter_strings
  Jsii::Type.check_type(@usb_device_filter_strings, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "usbDeviceFilterStrings") unless @usb_device_filter_strings.nil?
  @vpc_config = vpc_config.is_a?(Hash) ? ::AWSCDK::AppStream::CfnFleet::VPCConfigProperty.new(**vpc_config.transform_keys(&:to_sym)) : vpc_config
  Jsii::Type.check_type(@vpc_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuRmxlZXQuVnBjQ29uZmlnUHJvcGVydHkifV19fQ==")), "vpcConfig") unless @vpc_config.nil?
end

Instance Attribute Details

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

The desired capacity for the fleet.

This is not allowed for Elastic fleets.

Returns:

See Also:



156
157
158
 
# File 'app_stream/cfn_fleet_props.rb', line 156

def compute_capacity
  @compute_capacity
end

#description ⇒ String? (readonly)

The description to display.

Returns:

  • (String, nil)

See Also:



161
162
163
 
# File 'app_stream/cfn_fleet_props.rb', line 161

def description
  @description
end

#disable_imdsv1 ⇒ Boolean, ... (readonly)

Returns:

See Also:



164
165
166
 
# File 'app_stream/cfn_fleet_props.rb', line 164

def disable_imdsv1
  @disable_imdsv1
end

#disconnect_timeout_in_seconds ⇒ Numeric? (readonly)

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

If users try to reconnect to the streaming 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 streaming instance.

Specify a value between 60 and 36000.

Returns:

  • (Numeric, nil)

See Also:



173
174
175
 
# File 'app_stream/cfn_fleet_props.rb', line 173

def disconnect_timeout_in_seconds
  @disconnect_timeout_in_seconds
end

#display_name ⇒ String? (readonly)

The fleet name to display.

Returns:

  • (String, nil)

See Also:



178
179
180
 
# File 'app_stream/cfn_fleet_props.rb', line 178

def display_name
  @display_name
end

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

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

This is not allowed for Elastic fleets.

Returns:

See Also:



185
186
187
 
# File 'app_stream/cfn_fleet_props.rb', line 185

def domain_join_info
  @domain_join_info
end

#enable_default_internet_access ⇒ Boolean, ... (readonly)

Enables or disables default internet access for the fleet.

Returns:

See Also:



190
191
192
 
# File 'app_stream/cfn_fleet_props.rb', line 190

def enable_default_internet_access
  @enable_default_internet_access
end

#fleet_type ⇒ String? (readonly)

The fleet type.

  • ALWAYS_ON - Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.
  • ON_DEMAND - Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
  • ELASTIC - The pool of streaming instances is managed by Amazon AppStream 2.0. When a user selects their application or desktop to launch, they will start streaming after the app block has been downloaded and mounted to a streaming instance.

Allowed Values : ALWAYS_ON | ELASTIC | ON_DEMAND

Returns:

  • (String, nil)

See Also:



201
202
203
 
# File 'app_stream/cfn_fleet_props.rb', line 201

def fleet_type
  @fleet_type
end

#iam_role_arn ⇒ String? (readonly)

The ARN of the IAM role that is applied to the fleet.

To assume a role, the fleet instance calls the Security Token Service AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

Returns:

  • (String, nil)

See Also:



210
211
212
 
# File 'app_stream/cfn_fleet_props.rb', line 210

def iam_role_arn
  @iam_role_arn
end

#idle_disconnect_timeout_in_seconds ⇒ Numeric? (readonly)

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins.

Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000.

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

Returns:

  • (Numeric, nil)

See Also:



221
222
223
 
# File 'app_stream/cfn_fleet_props.rb', line 221

def idle_disconnect_timeout_in_seconds
  @idle_disconnect_timeout_in_seconds
end

#image_arn ⇒ String? (readonly)

The ARN of the public, private, or shared image to use.

Returns:

  • (String, nil)

See Also:



226
227
228
 
# File 'app_stream/cfn_fleet_props.rb', line 226

def image_arn
  @image_arn
end

#image_name ⇒ String? (readonly)

The name of the image used to create the fleet.

Returns:

  • (String, nil)

See Also:



231
232
233
 
# File 'app_stream/cfn_fleet_props.rb', line 231

def image_name
  @image_name
end

#instance_type ⇒ String (readonly)

The instance type to use when launching fleet instances. The following instance types are available for non-Elastic fleets:.

  • stream.standard.small
  • stream.standard.medium
  • stream.standard.large
  • stream.compute.large
  • stream.compute.xlarge
  • stream.compute.2xlarge
  • stream.compute.4xlarge
  • stream.compute.8xlarge
  • stream.memory.large
  • stream.memory.xlarge
  • stream.memory.2xlarge
  • stream.memory.4xlarge
  • stream.memory.8xlarge
  • stream.memory.z1d.large
  • stream.memory.z1d.xlarge
  • stream.memory.z1d.2xlarge
  • stream.memory.z1d.3xlarge
  • stream.memory.z1d.6xlarge
  • stream.memory.z1d.12xlarge
  • stream.graphics-design.large
  • stream.graphics-design.xlarge
  • stream.graphics-design.2xlarge
  • stream.graphics-design.4xlarge
  • stream.graphics.g4dn.xlarge
  • stream.graphics.g4dn.2xlarge
  • stream.graphics.g4dn.4xlarge
  • stream.graphics.g4dn.8xlarge
  • stream.graphics.g4dn.12xlarge
  • stream.graphics.g4dn.16xlarge
  • stream.graphics.g5.xlarge
  • stream.graphics.g5.2xlarge
  • stream.graphics.g5.4xlarge
  • stream.graphics.g5.8xlarge
  • stream.graphics.g5.16xlarge
  • stream.graphics.g5.12xlarge
  • stream.graphics.g5.24xlarge
  • stream.graphics.g6.xlarge
  • stream.graphics.g6.2xlarge
  • stream.graphics.g6.4xlarge
  • stream.graphics.g6.8xlarge
  • stream.graphics.g6.16xlarge
  • stream.graphics.g6.12xlarge
  • stream.graphics.g6.24xlarge
  • stream.graphics.gr6.4xlarge
  • stream.graphics.gr6.8xlarge
  • stream.graphics.g6f.large
  • stream.graphics.g6f.xlarge
  • stream.graphics.g6f.2xlarge
  • stream.graphics.g6f.4xlarge
  • stream.graphics.gr6f.4xlarge

The following instance types are available for Elastic fleets:

  • stream.standard.small
  • stream.standard.medium

Returns:

  • (String)

See Also:



144
145
146
 
# File 'app_stream/cfn_fleet_props.rb', line 144

def instance_type
  @instance_type
end

#max_concurrent_sessions ⇒ Numeric? (readonly)

The maximum number of concurrent sessions that can be run on an Elastic fleet.

This setting is required for Elastic fleets, but is not used for other fleet types.

Returns:

  • (Numeric, nil)

See Also:



238
239
240
 
# File 'app_stream/cfn_fleet_props.rb', line 238

def max_concurrent_sessions
  @max_concurrent_sessions
end

#max_sessions_per_instance ⇒ Numeric? (readonly)

Max number of user sessions on an instance.

This is applicable only for multi-session fleets.

Returns:

  • (Numeric, nil)

See Also:



245
246
247
 
# File 'app_stream/cfn_fleet_props.rb', line 245

def max_sessions_per_instance
  @max_sessions_per_instance
end

#max_user_duration_in_seconds ⇒ Numeric? (readonly)

The maximum amount of time that a streaming session can remain active, in seconds.

If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Specify a value between 600 and 432000.

Returns:

  • (Numeric, nil)

See Also:



254
255
256
 
# File 'app_stream/cfn_fleet_props.rb', line 254

def max_user_duration_in_seconds
  @max_user_duration_in_seconds
end

#name ⇒ String (readonly)

A unique name for the fleet.

Returns:

  • (String)

See Also:



149
150
151
 
# File 'app_stream/cfn_fleet_props.rb', line 149

def name
  @name
end

#platform ⇒ String? (readonly)

The platform of the fleet.

Platform is a required setting for Elastic fleets, and is not used for other fleet types.

Returns:

  • (String, nil)

See Also:



261
262
263
 
# File 'app_stream/cfn_fleet_props.rb', line 261

def platform
  @platform
end

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

Returns:

See Also:



264
265
266
 
# File 'app_stream/cfn_fleet_props.rb', line 264

def root_volume_config
  @root_volume_config
end

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

The S3 location of the session scripts configuration zip file.

This only applies to Elastic fleets.

Returns:

See Also:



271
272
273
 
# File 'app_stream/cfn_fleet_props.rb', line 271

def session_script_s3_location
  @session_script_s3_location
end

#stream_view ⇒ String? (readonly)

The WorkSpaces Applications view that is displayed to your users when they stream from the fleet.

When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

The default value is APP .

Returns:

  • (String, nil)

See Also:



280
281
282
 
# File 'app_stream/cfn_fleet_props.rb', line 280

def stream_view
  @stream_view
end

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

An array of key-value pairs.

Returns:

See Also:



285
286
287
 
# File 'app_stream/cfn_fleet_props.rb', line 285

def tags
  @tags
end

#usb_device_filter_strings ⇒ Array<String>? (readonly)

The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client.

This is allowed but not required for Elastic fleets.

Returns:

  • (Array<String>, nil)

See Also:



292
293
294
 
# File 'app_stream/cfn_fleet_props.rb', line 292

def usb_device_filter_strings
  @usb_device_filter_strings
end

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

The VPC configuration for the fleet.

This is required for Elastic fleets, but not required for other fleet types.

Returns:

See Also:



299
300
301
 
# File 'app_stream/cfn_fleet_props.rb', line 299

def vpc_config
  @vpc_config
end

Class Method Details

.jsii_properties ⇒ Object 



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'app_stream/cfn_fleet_props.rb', line 301

def self.jsii_properties
  {
    :instance_type => "instanceType",
    :name => "name",
    :compute_capacity => "computeCapacity",
    :description => "description",
    :disable_imdsv1 => "disableImdsv1",
    :disconnect_timeout_in_seconds => "disconnectTimeoutInSeconds",
    :display_name => "displayName",
    :domain_join_info => "domainJoinInfo",
    :enable_default_internet_access => "enableDefaultInternetAccess",
    :fleet_type => "fleetType",
    :iam_role_arn => "iamRoleArn",
    :idle_disconnect_timeout_in_seconds => "idleDisconnectTimeoutInSeconds",
    :image_arn => "imageArn",
    :image_name => "imageName",
    :max_concurrent_sessions => "maxConcurrentSessions",
    :max_sessions_per_instance => "maxSessionsPerInstance",
    :max_user_duration_in_seconds => "maxUserDurationInSeconds",
    :platform => "platform",
    :root_volume_config => "rootVolumeConfig",
    :session_script_s3_location => "sessionScriptS3Location",
    :stream_view => "streamView",
    :tags => "tags",
    :usb_device_filter_strings => "usbDeviceFilterStrings",
    :vpc_config => "vpcConfig",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'app_stream/cfn_fleet_props.rb', line 330

def to_jsii
  result = {}
  result.merge!({
    "instanceType" => @instance_type,
    "name" => @name,
    "computeCapacity" => @compute_capacity,
    "description" => @description,
    "disableImdsv1" => @disable_imdsv1,
    "disconnectTimeoutInSeconds" => @disconnect_timeout_in_seconds,
    "displayName" => @display_name,
    "domainJoinInfo" => @domain_join_info,
    "enableDefaultInternetAccess" => @enable_default_internet_access,
    "fleetType" => @fleet_type,
    "iamRoleArn" => @iam_role_arn,
    "idleDisconnectTimeoutInSeconds" => @idle_disconnect_timeout_in_seconds,
    "imageArn" => @image_arn,
    "imageName" => @image_name,
    "maxConcurrentSessions" => @max_concurrent_sessions,
    "maxSessionsPerInstance" => @max_sessions_per_instance,
    "maxUserDurationInSeconds" => @max_user_duration_in_seconds,
    "platform" => @platform,
    "rootVolumeConfig" => @root_volume_config,
    "sessionScriptS3Location" => @session_script_s3_location,
    "streamView" => @stream_view,
    "tags" => @tags,
    "usbDeviceFilterStrings" => @usb_device_filter_strings,
    "vpcConfig" => @vpc_config,
  })
  result.compact
end