# AgentAccessConfigProperty

The configuration for agent access on a stack.

Agent access enables AI agents to interact with desktop applications during streaming sessions.

- Source: Generated code
- Type last changed: v2.262.0 · 22 Jul 2026

## Example

```ts
// 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

- `s3BucketArn`: string — The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored.

  Required when ScreenshotsUploadEnabled is true.

- `screenImageFormat`: string (required) — The image format for agent screen captures.

- `screenResolution`: string (required) — The screen resolution for the agent streaming environment.

- `screenshotsUploadEnabled`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Indicates whether screenshot uploads to Amazon S3 are enabled for agent sessions.

- `settings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnStack.AgentAccessSettingProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_appstream.CfnStack.AgentAccessSettingProperty.html)[] (required) — The list of agent access settings that define permissions for each agent action.

  You must specify at least one setting.

- `userControlMode`: string — 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.