# AgentAccessConfigProperty

The configuration for agent access on a stack.

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

- Source: Generated at build time
- Type last changed: v2.262.0 · 22 Jul 2026

## Example

TypeScript:

```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',
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appstream as appstream

agent_access_config_property = appstream.CfnStack.AgentAccessConfigProperty(
    screen_image_format="screenImageFormat",
    screen_resolution="screenResolution",
    settings=[appstream.CfnStack.AgentAccessSettingProperty(
        agent_action="agentAction",
        permission="permission"
    )],

    # the properties below are optional
    s3_bucket_arn="s3BucketArn",
    screenshots_upload_enabled=False,
    user_control_mode="userControlMode"
)
```

Java:

```java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.appstream.*;

AgentAccessConfigProperty agentAccessConfigProperty = AgentAccessConfigProperty.builder()
        .screenImageFormat("screenImageFormat")
        .screenResolution("screenResolution")
        .settings(List.of(AgentAccessSettingProperty.builder()
                .agentAction("agentAction")
                .permission("permission")
                .build()))

        // the properties below are optional
        .s3BucketArn("s3BucketArn")
        .screenshotsUploadEnabled(false)
        .userControlMode("userControlMode")
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppStream;

var agentAccessConfigProperty = new AgentAccessConfigProperty {
    ScreenImageFormat = "screenImageFormat",
    ScreenResolution = "screenResolution",
    Settings = new [] { new AgentAccessSettingProperty {
        AgentAction = "agentAction",
        Permission = "permission"
    } },

    // the properties below are optional
    S3BucketArn = "s3BucketArn",
    ScreenshotsUploadEnabled = false,
    UserControlMode = "userControlMode"
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

agentAccessConfigProperty := &AgentAccessConfigProperty{
	ScreenImageFormat: jsii.String("screenImageFormat"),
	ScreenResolution: jsii.String("screenResolution"),
	Settings: []interface{}{
		&AgentAccessSettingProperty{
			AgentAction: jsii.String("agentAction"),
			Permission: jsii.String("permission"),
		},
	},

	// the properties below are optional
	S3BucketArn: jsii.String("s3BucketArn"),
	ScreenshotsUploadEnabled: jsii.Boolean(false),
	UserControlMode: jsii.String("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](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Indicates whether screenshot uploads to Amazon S3 are enabled for agent sessions.

- `settings`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnStack.AgentAccessSettingProperty](https://docs.aws.amazon.com/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.
