Package software.amazon.awscdk.cfnpropertymixins.services.appstream

Interface CfnStackPropsMixin.AgentAccessConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStackPropsMixin.AgentAccessConfigProperty.Jsii$Proxy

Enclosing class:

CfnStackPropsMixin

@Stability(Stable)
public static interface CfnStackPropsMixin.AgentAccessConfigProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.cfnpropertymixins.services.appstream.*;
 AgentAccessConfigProperty agentAccessConfigProperty = AgentAccessConfigProperty.builder()
         .s3BucketArn("s3BucketArn")
         .screenImageFormat("screenImageFormat")
         .screenResolution("screenResolution")
         .screenshotsUploadEnabled(false)
         .settings(List.of(AgentAccessSettingProperty.builder()
                 .agentAction("agentAction")
                 .permission("permission")
                 .build()))
         .userControlMode("userControlMode")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStackPropsMixin.AgentAccessConfigProperty.Builder	A builder for CfnStackPropsMixin.AgentAccessConfigProperty
static final class	CfnStackPropsMixin.AgentAccessConfigProperty.Jsii$Proxy	An implementation for CfnStackPropsMixin.AgentAccessConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnStackPropsMixin.AgentAccessConfigProperty.Builder	builder()
default String	getS3BucketArn()	The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored.
default String	getScreenImageFormat()	The image format for agent screen captures.
default String	getScreenResolution()	The screen resolution for the agent streaming environment.
default Object	getScreenshotsUploadEnabled()	Indicates whether screenshot uploads to Amazon S3 are enabled for agent sessions.
default Object	getSettings()	The list of agent access settings that define permissions for each agent action.
default String	getUserControlMode()	The user control mode for agent sessions.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getS3BucketArn

@Stability(Stable)
@Nullable
default String getS3BucketArn()

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

getScreenImageFormat

@Stability(Stable)
@Nullable
default String getScreenImageFormat()

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

getScreenResolution

@Stability(Stable)
@Nullable
default String getScreenResolution()

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

getScreenshotsUploadEnabled

@Stability(Stable)
@Nullable
default Object getScreenshotsUploadEnabled()

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

Returns union: either Boolean or IResolvable

See Also:

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

getSettings

@Stability(Stable)
@Nullable
default Object getSettings()

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

You must specify at least one setting.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnStackPropsMixin.AgentAccessSettingProperty>

See Also:

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

getUserControlMode

@Stability(Stable)
@Nullable
default String getUserControlMode()

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

builder

@Stability(Stable)
static CfnStackPropsMixin.AgentAccessConfigProperty.Builder builder()

Returns:

a CfnStackPropsMixin.AgentAccessConfigProperty.Builder of CfnStackPropsMixin.AgentAccessConfigProperty