Interface ImageBuilderAgentAccessConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ImageBuilderAgentAccessConfig.Builder,ImageBuilderAgentAccessConfig>, SdkBuilder<ImageBuilderAgentAccessConfig.Builder,ImageBuilderAgentAccessConfig>, SdkPojo

Enclosing class:

ImageBuilderAgentAccessConfig

@Mutable
@NotThreadSafe
public static interface ImageBuilderAgentAccessConfig.Builder
extends SdkPojo, CopyableBuilder<ImageBuilderAgentAccessConfig.Builder,ImageBuilderAgentAccessConfig>

Method Summary

Modifier and Type	Method	Description
ImageBuilderAgentAccessConfig.Builder	s3BucketArn(String s3BucketArn)	The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored.
ImageBuilderAgentAccessConfig.Builder	screenImageFormat(String screenImageFormat)	The image format for agent screen captures.
ImageBuilderAgentAccessConfig.Builder	screenImageFormat(ScreenImageFormat screenImageFormat)	The image format for agent screen captures.
ImageBuilderAgentAccessConfig.Builder	screenResolution(String screenResolution)	The screen resolution for the agent streaming environment.
ImageBuilderAgentAccessConfig.Builder	screenResolution(ScreenResolution screenResolution)	The screen resolution for the agent streaming environment.
ImageBuilderAgentAccessConfig.Builder	screenshotsUploadEnabled(Boolean screenshotsUploadEnabled)	Specifies whether screenshot uploads to Amazon S3 are enabled for agent sessions.
ImageBuilderAgentAccessConfig.Builder	settings(Collection<AgentAccessSetting> settings)	The list of agent access settings that define permissions for each agent action.
ImageBuilderAgentAccessConfig.Builder	settings(Consumer<AgentAccessSetting.Builder>... settings)	The list of agent access settings that define permissions for each agent action.
ImageBuilderAgentAccessConfig.Builder	settings(AgentAccessSetting... settings)	The list of agent access settings that define permissions for each agent action.
ImageBuilderAgentAccessConfig.Builder	userControlMode(String userControlMode)	The user control mode for agent sessions.
ImageBuilderAgentAccessConfig.Builder	userControlMode(UserControlMode userControlMode)	The user control mode for agent sessions.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

settings

ImageBuilderAgentAccessConfig.Builder settings(Collection<AgentAccessSetting> settings)

The list of agent access settings that define permissions for each agent action. You must specify at least one setting, and at least one agent action must be enabled.

Parameters:

settings - The list of agent access settings that define permissions for each agent action. You must specify at least one setting, and at least one agent action must be enabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

settings

ImageBuilderAgentAccessConfig.Builder settings(AgentAccessSetting... settings)

The list of agent access settings that define permissions for each agent action. You must specify at least one setting, and at least one agent action must be enabled.

Parameters:

settings - The list of agent access settings that define permissions for each agent action. You must specify at least one setting, and at least one agent action must be enabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

settings

ImageBuilderAgentAccessConfig.Builder settings(Consumer<AgentAccessSetting.Builder>... settings)

The list of agent access settings that define permissions for each agent action. You must specify at least one setting, and at least one agent action must be enabled.

This is a convenience method that creates an instance of the AgentAccessSetting.Builder avoiding the need to create one manually via AgentAccessSetting.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to settings(List<AgentAccessSetting>).

Parameters:

settings - a consumer that will call methods on AgentAccessSetting.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• settings(java.util.Collection<AgentAccessSetting>)

s3BucketArn

ImageBuilderAgentAccessConfig.Builder s3BucketArn(String s3BucketArn)

The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored. Required when ScreenshotsUploadEnabled is true.

Parameters:

s3BucketArn - The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored. Required when ScreenshotsUploadEnabled is true.

Returns:

Returns a reference to this object so that method calls can be chained together.

screenshotsUploadEnabled

ImageBuilderAgentAccessConfig.Builder screenshotsUploadEnabled(Boolean screenshotsUploadEnabled)

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

Parameters:

screenshotsUploadEnabled - Specifies whether screenshot uploads to Amazon S3 are enabled for agent sessions.

Returns:

Returns a reference to this object so that method calls can be chained together.

screenResolution

ImageBuilderAgentAccessConfig.Builder screenResolution(String screenResolution)

The screen resolution for the agent streaming environment.

• W_1280xH_720 - 1280 x 720 pixels.

Parameters:

screenResolution - The screen resolution for the agent streaming environment.

• W_1280xH_720 - 1280 x 720 pixels.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ScreenResolution
• ScreenResolution

screenResolution

ImageBuilderAgentAccessConfig.Builder screenResolution(ScreenResolution screenResolution)

The screen resolution for the agent streaming environment.

• W_1280xH_720 - 1280 x 720 pixels.

Parameters:

screenResolution - The screen resolution for the agent streaming environment.

• W_1280xH_720 - 1280 x 720 pixels.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ScreenResolution
• ScreenResolution

screenImageFormat

ImageBuilderAgentAccessConfig.Builder screenImageFormat(String screenImageFormat)

The image format for agent screen captures.

• PNG - PNG format.

• JPEG - JPEG format.

Parameters:

screenImageFormat - The image format for agent screen captures.

• PNG - PNG format.

• JPEG - JPEG format.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ScreenImageFormat
• ScreenImageFormat

screenImageFormat

ImageBuilderAgentAccessConfig.Builder screenImageFormat(ScreenImageFormat screenImageFormat)

The image format for agent screen captures.

• PNG - PNG format.

• JPEG - JPEG format.

Parameters:

screenImageFormat - The image format for agent screen captures.

• PNG - PNG format.

• JPEG - JPEG format.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ScreenImageFormat
• ScreenImageFormat

userControlMode

ImageBuilderAgentAccessConfig.Builder userControlMode(String userControlMode)

The user control mode for agent sessions. This setting determines how users can interact with agent sessions.

• VIEW_ONLY - Users can view and observe agent actions as they happen.

• VIEW_STOP - Users can view agent actions and stop the agent if needed.

• DISABLED - Users cannot view or stop the agent session.

Parameters:

userControlMode - The user control mode for agent sessions. This setting determines how users can interact with agent sessions.

• VIEW_ONLY - Users can view and observe agent actions as they happen.

• VIEW_STOP - Users can view agent actions and stop the agent if needed.

• DISABLED - Users cannot view or stop the agent session.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• UserControlMode
• UserControlMode

userControlMode

ImageBuilderAgentAccessConfig.Builder userControlMode(UserControlMode userControlMode)

The user control mode for agent sessions. This setting determines how users can interact with agent sessions.

• VIEW_ONLY - Users can view and observe agent actions as they happen.

• VIEW_STOP - Users can view agent actions and stop the agent if needed.

• DISABLED - Users cannot view or stop the agent session.

Parameters:

userControlMode - The user control mode for agent sessions. This setting determines how users can interact with agent sessions.

• VIEW_ONLY - Users can view and observe agent actions as they happen.

• VIEW_STOP - Users can view agent actions and stop the agent if needed.

• DISABLED - Users cannot view or stop the agent session.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• UserControlMode
• UserControlMode