View a markdown version of this page

AWS::AppStream::Stack AgentAccessConfig - AWS CloudFormation

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::AppStream::Stack AgentAccessConfig

The configuration for agent access on a stack. Agent access enables AI agents to interact with desktop applications during streaming sessions.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{ "S3BucketArn" : String, "ScreenImageFormat" : String, "ScreenResolution" : String, "ScreenshotsUploadEnabled" : Boolean, "Settings" : [ AgentAccessSetting, ... ], "UserControlMode" : String }

Properties

S3BucketArn

The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored. Required when ScreenshotsUploadEnabled is true.

Required: No

Type: String

Pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:s3:::[a-z0-9][a-z0-9.\-]{1,61}[a-z0-9]$

Update requires: No interruption

ScreenImageFormat

The image format for agent screen captures.

Required: Yes

Type: String

Allowed values: PNG | JPEG

Update requires: No interruption

ScreenResolution

The screen resolution for the agent streaming environment.

Required: Yes

Type: String

Allowed values: W_1280xH_720

Update requires: No interruption

ScreenshotsUploadEnabled

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

Required: No

Type: Boolean

Update requires: No interruption

Settings

The list of agent access settings that define permissions for each agent action. You must specify at least one setting.

Required: Yes

Type: Array of AgentAccessSetting

Update requires: No interruption

UserControlMode

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

Required: No

Type: String

Allowed values: VIEW_ONLY | VIEW_STOP | DISABLED

Update requires: No interruption