AgentAccessConfigProperty Struct
The configuration for agent access on a stack.
Agent access enables AI agents to interact with desktop applications during streaming sessions.
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',
};
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
// 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();
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"
};
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
s3BucketArnoptionalstrings3_bucket_arnoptionalstrs3BucketArnoptionalStringS3BucketArnoptionalstringS3BucketArnoptional*string#The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored.
Required when ScreenshotsUploadEnabled is true.
screenImageFormatstringscreen_image_formatstrscreenImageFormatStringScreenImageFormatstringScreenImageFormat*stringrequired#The image format for agent screen captures.
screenResolutionstringscreen_resolutionstrscreenResolutionStringScreenResolutionstringScreenResolution*stringrequired#The screen resolution for the agent streaming environment.
screenshotsUploadEnabledoptionalboolean | IResolvablescreenshots_upload_enabledoptionaltyping.Union[bool, IResolvable]screenshotsUploadEnabledoptionalBooleanScreenshotsUploadEnabledoptionalboolScreenshotsUploadEnabledoptionalinterface{}#Indicates whether screenshot uploads to Amazon S3 are enabled for agent sessions.
settingsIResolvable | IResolvable | CfnStack.AgentAccessSettingProperty[]settingstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AgentAccessSettingProperty]]]settingsIResolvableSettingsIResolvableSettingsinterface{}required#The list of agent access settings that define permissions for each agent action.
You must specify at least one setting.
userControlModeoptionalstringuser_control_modeoptionalstruserControlModeoptionalStringUserControlModeoptionalstringUserControlModeoptional*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.