interface TimeoutSettingsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.WorkSpaces.CfnWorkspacesPool.TimeoutSettingsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsworkspaces#CfnWorkspacesPool_TimeoutSettingsProperty`
Java	`software.amazon.awscdk.services.workspaces.CfnWorkspacesPool.TimeoutSettingsProperty`
Python	`aws_cdk.aws_workspaces.CfnWorkspacesPool.TimeoutSettingsProperty`
TypeScript	`aws-cdk-lib` » `aws_workspaces` » `CfnWorkspacesPool` » `TimeoutSettingsProperty`

Describes the timeout settings for the pool.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspaces as workspaces } from 'aws-cdk-lib';
const timeoutSettingsProperty: workspaces.CfnWorkspacesPool.TimeoutSettingsProperty = {
  disconnectTimeoutInSeconds: 123,
  idleDisconnectTimeoutInSeconds: 123,
  maxUserDurationInSeconds: 123,
};

Properties

Name	Type	Description
disconnectTimeoutInSeconds?	`number`	Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect.
idleDisconnectTimeoutInSeconds?	`number`	The amount of time in seconds a connection will stay active while idle.
maxUserDurationInSeconds?	`number`	Specifies the maximum amount of time, in seconds, that a streaming session can remain active.

disconnectTimeoutInSeconds?

Type: number (optional)

Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect.

If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

idleDisconnectTimeoutInSeconds?

Type: number (optional)

The amount of time in seconds a connection will stay active while idle.

maxUserDurationInSeconds?

Type: number (optional)

Specifies the maximum amount of time, in seconds, that a streaming session can remain active.

If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.