AgentAccessConfigForUpdate
The configuration for updating agent access on a stack. This type supports partial updates, so you only need to specify the fields you want to change.
Contents
- KmsKeyArn
-
The Amazon Resource Name (ARN) of the customer managed symmetric encryption KMS key that encrypts Replay Session artifacts while WorkSpaces Applications processes them. To remove the key, use AttributesToDelete with the AGENT_ACCESS_CONFIG_KMS_KEY_ARN value.
Type: String
Pattern:
^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:kms:[a-z0-9\-]+:\d{12}:key/[A-Za-z0-9\-]+$Required: No
- ReplaySessionEnabled
-
Indicates whether Replay Session is enabled for agent sessions. Setting this attribute to false also removes the KmsKeyArn value from the stack.
Type: Boolean
Required: No
- S3BucketArn
-
The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots and Replay Session artifacts are stored.
Type: String
Pattern:
^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:s3:::[a-z0-9][a-z0-9.\-]{1,61}[a-z0-9]$Required: No
- ScreenImageFormat
-
The image format for agent screen captures.
Type: String
Valid Values:
PNG | JPEGRequired: No
- ScreenResolution
-
The screen resolution for the agent streaming environment.
Type: String
Valid Values:
W_1280xH_720Required: No
- ScreenshotsUploadEnabled
-
Indicates whether screenshot uploads to Amazon S3 are enabled for agent sessions.
Type: Boolean
Required: No
- Settings
-
The list of agent access settings that define permissions for each agent action. The merged settings must have at least one agent action enabled.
Type: Array of AgentAccessSetting objects
Required: No
- UserControlMode
-
The user control mode for agent sessions. This setting determines how users can interact with agent sessions.
Type: String
Valid Values:
VIEW_ONLY | VIEW_STOP | DISABLEDRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: