interface AgentAccessConfigProperty

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.AppStream.CfnStackPropsMixin.AgentAccessConfigProperty
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsappstream#CfnStackPropsMixin_AgentAccessConfigProperty
Java	software.amazon.awscdk.cfnpropertymixins.services.appstream.CfnStackPropsMixin.AgentAccessConfigProperty
Python	aws_cdk.cfn_property_mixins.aws_appstream.CfnStackPropsMixin.AgentAccessConfigProperty
TypeScript	@aws-cdk/cfn-property-mixins » aws_appstream » CfnStackPropsMixin » AgentAccessConfigProperty

The configuration for agent access on a stack.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccessconfig.html

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/cfn-property-mixins';
const agentAccessConfigProperty: appstream.CfnStackPropsMixin.AgentAccessConfigProperty = {
  s3BucketArn: 's3BucketArn',
  screenImageFormat: 'screenImageFormat',
  screenResolution: 'screenResolution',
  screenshotsUploadEnabled: false,
  settings: [{
    agentAction: 'agentAction',
    permission: 'permission',
  }],
  userControlMode: 'userControlMode',
};

Properties

Name	Type	Description
s3BucketArn?	string	The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored.
screenImageFormat?	string	The image format for agent screen captures.
screenResolution?	string	The screen resolution for the agent streaming environment.
screenshotsUploadEnabled?	boolean | IResolvable	Indicates whether screenshot uploads to Amazon S3 are enabled for agent sessions.
settings?	IResolvable | (IResolvable | AgentAccessSettingProperty)[]	The list of agent access settings that define permissions for each agent action.
userControlMode?	string	The user control mode for agent sessions.

---

s3BucketArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored.

Required when ScreenshotsUploadEnabled is true.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccessconfig.html#cfn-appstream-stack-agentaccessconfig-s3bucketarn

---

screenImageFormat?

Type: string (optional)

The image format for agent screen captures.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccessconfig.html#cfn-appstream-stack-agentaccessconfig-screenimageformat

---

screenResolution?

Type: string (optional)

The screen resolution for the agent streaming environment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccessconfig.html#cfn-appstream-stack-agentaccessconfig-screenresolution

---

screenshotsUploadEnabled?

Type: boolean | IResolvable (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccessconfig.html#cfn-appstream-stack-agentaccessconfig-screenshotsuploadenabled

---

settings?

Type: IResolvable | (IResolvable | AgentAccessSettingProperty)[] (optional)

The list of agent access settings that define permissions for each agent action.

You must specify at least one setting.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccessconfig.html#cfn-appstream-stack-agentaccessconfig-settings

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccessconfig.html#cfn-appstream-stack-agentaccessconfig-usercontrolmode