interface AgentAccessConfigProperty
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.AppStream.CfnStack.AgentAccessConfigProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsappstream#CfnStack_AgentAccessConfigProperty |
Java | software.amazon.awscdk.services.appstream.CfnStack.AgentAccessConfigProperty |
Python | aws_cdk.aws_appstream.CfnStack.AgentAccessConfigProperty |
TypeScript | aws-cdk-lib » aws_appstream » CfnStack » AgentAccessConfigProperty |
The configuration for agent access on a stack.
Agent access enables AI agents to interact with desktop applications during streaming sessions.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appstream as appstream } from 'aws-cdk-lib';
const agentAccessConfigProperty: appstream.CfnStack.AgentAccessConfigProperty = {
screenImageFormat: 'screenImageFormat',
screenResolution: 'screenResolution',
settings: [{
agentAction: 'agentAction',
permission: 'permission',
}],
// the properties below are optional
s3BucketArn: 's3BucketArn',
screenshotsUploadEnabled: false,
userControlMode: 'userControlMode',
};
Properties
| Name | Type | Description |
|---|---|---|
| screen | string | The image format for agent screen captures. |
| screen | string | The screen resolution for the agent streaming environment. |
| settings | IResolvable | (IResolvable | Agent)[] | The list of agent access settings that define permissions for each agent action. |
| s3 | string | The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored. |
| screenshots | boolean | IResolvable | Indicates whether screenshot uploads to Amazon S3 are enabled for agent sessions. |
| user | string | The user control mode for agent sessions. |
screenImageFormat
Type:
string
The image format for agent screen captures.
screenResolution
Type:
string
The screen resolution for the agent streaming environment.
settings
Type:
IResolvable | (IResolvable | Agent)[]
The list of agent access settings that define permissions for each agent action.
You must specify at least one setting.
s3BucketArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored.
Required when ScreenshotsUploadEnabled is true.
screenshotsUploadEnabled?
Type:
boolean | IResolvable
(optional)
Indicates whether screenshot uploads to Amazon S3 are enabled for agent sessions.
userControlMode?
Type:
string
(optional)
The user control mode for agent sessions.
This setting determines how users can interact with agent sessions. Valid values are VIEW_ONLY, VIEW_STOP, and DISABLED.

.NET
Go
Java
Python
TypeScript