Class: Aws::AppStream::Types::ImageBuilderAgentAccessConfigForUpdate

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb

Overview

The configuration for updating agent access on an image builder. This type supports partial updates, so you only need to specify the fields you want to change. Fields that you omit keep their stored values.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#s3_bucket_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored. If ScreenshotsUploadEnabled is false after the merge, the stored bucket ARN is removed.

Returns:

  • (String)


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5378

class ImageBuilderAgentAccessConfigForUpdate < Struct.new(
  :settings,
  :s3_bucket_arn,
  :screenshots_upload_enabled,
  :screen_resolution,
  :screen_image_format,
  :user_control_mode)
  SENSITIVE = []
  include Aws::Structure
end

#screen_image_format ⇒ String

The image format for agent screen captures.

  • PNG - PNG format.

  • JPEG - JPEG format.

Returns:

  • (String)


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5378

class ImageBuilderAgentAccessConfigForUpdate < Struct.new(
  :settings,
  :s3_bucket_arn,
  :screenshots_upload_enabled,
  :screen_resolution,
  :screen_image_format,
  :user_control_mode)
  SENSITIVE = []
  include Aws::Structure
end

#screen_resolution ⇒ String

The screen resolution for the agent streaming environment.

  • W_1280xH_720 - 1280 x 720 pixels.

^

Returns:

  • (String)


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5378

class ImageBuilderAgentAccessConfigForUpdate < Struct.new(
  :settings,
  :s3_bucket_arn,
  :screenshots_upload_enabled,
  :screen_resolution,
  :screen_image_format,
  :user_control_mode)
  SENSITIVE = []
  include Aws::Structure
end

#screenshots_upload_enabled ⇒ Boolean

Specifies whether screenshot uploads to Amazon S3 are enabled for agent sessions.

Returns:

  • (Boolean)


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5378

class ImageBuilderAgentAccessConfigForUpdate < Struct.new(
  :settings,
  :s3_bucket_arn,
  :screenshots_upload_enabled,
  :screen_resolution,
  :screen_image_format,
  :user_control_mode)
  SENSITIVE = []
  include Aws::Structure
end

#settings ⇒ Array<Types::AgentAccessSetting>

The list of agent access settings that define permissions for each agent action. These settings are merged with the stored settings by agent action. A setting that you specify replaces the stored setting for the same agent action. The merged settings must have at least one agent action enabled.

Returns:



5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5378

class ImageBuilderAgentAccessConfigForUpdate < Struct.new(
  :settings,
  :s3_bucket_arn,
  :screenshots_upload_enabled,
  :screen_resolution,
  :screen_image_format,
  :user_control_mode)
  SENSITIVE = []
  include Aws::Structure
end

#user_control_mode ⇒ String

The user control mode for agent sessions. This setting determines how users can interact with agent sessions.

  • VIEW_ONLY - Users can view and observe agent actions as they happen.

  • VIEW_STOP - Users can view agent actions and stop the agent if needed.

  • DISABLED - Users cannot view or stop the agent session.

Returns:

  • (String)


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5378

class ImageBuilderAgentAccessConfigForUpdate < Struct.new(
  :settings,
  :s3_bucket_arn,
  :screenshots_upload_enabled,
  :screen_resolution,
  :screen_image_format,
  :user_control_mode)
  SENSITIVE = []
  include Aws::Structure
end