Package software.amazon.awssdk.services.workspacesthinclient.model

Interface UpdateEnvironmentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>, SdkBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>, SdkPojo, SdkRequest.Builder, WorkSpacesThinClientRequest.Builder

Enclosing class:

UpdateEnvironmentRequest

public static interface UpdateEnvironmentRequest.Builder
extends WorkSpacesThinClientRequest.Builder, SdkPojo, CopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

Method Summary

Modifier and Type	Method	Description
UpdateEnvironmentRequest.Builder	desiredSoftwareSetId(String desiredSoftwareSetId)	The ID of the software set to apply.
UpdateEnvironmentRequest.Builder	desktopArn(String desktopArn)	The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
UpdateEnvironmentRequest.Builder	desktopEndpoint(String desktopEndpoint)	The URL for the identity provider login (only for environments that use AppStream 2.0).
UpdateEnvironmentRequest.Builder	deviceCreationTags(Map<String,String> deviceCreationTags)	A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
UpdateEnvironmentRequest.Builder	id(String id)	The ID of the environment to update.
default UpdateEnvironmentRequest.Builder	maintenanceWindow(Consumer<MaintenanceWindow.Builder> maintenanceWindow)	A specification for a time window to apply software updates.
UpdateEnvironmentRequest.Builder	maintenanceWindow(MaintenanceWindow maintenanceWindow)	A specification for a time window to apply software updates.
UpdateEnvironmentRequest.Builder	name(String name)	The name of the environment to update.
UpdateEnvironmentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateEnvironmentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
UpdateEnvironmentRequest.Builder	softwareSetUpdateMode(String softwareSetUpdateMode)	An option to define which software updates to apply.
UpdateEnvironmentRequest.Builder	softwareSetUpdateMode(SoftwareSetUpdateMode softwareSetUpdateMode)	An option to define which software updates to apply.
UpdateEnvironmentRequest.Builder	softwareSetUpdateSchedule(String softwareSetUpdateSchedule)	An option to define if software updates should be applied within a maintenance window.
UpdateEnvironmentRequest.Builder	softwareSetUpdateSchedule(SoftwareSetUpdateSchedule softwareSetUpdateSchedule)	An option to define if software updates should be applied within a maintenance window.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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, sdkFields

Methods inherited from interface software.amazon.awssdk.services.workspacesthinclient.model.WorkSpacesThinClientRequest.Builder

build

Method Details

id

UpdateEnvironmentRequest.Builder id(String id)

The ID of the environment to update.

Parameters:

id - The ID of the environment to update.

Returns:

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

name

UpdateEnvironmentRequest.Builder name(String name)

The name of the environment to update.

Parameters:

name - The name of the environment to update.

Returns:

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

desktopArn

UpdateEnvironmentRequest.Builder desktopArn(String desktopArn)

The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

Parameters:

desktopArn - The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

Returns:

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

desktopEndpoint

UpdateEnvironmentRequest.Builder desktopEndpoint(String desktopEndpoint)

The URL for the identity provider login (only for environments that use AppStream 2.0).

Parameters:

desktopEndpoint - The URL for the identity provider login (only for environments that use AppStream 2.0).

Returns:

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

softwareSetUpdateSchedule

UpdateEnvironmentRequest.Builder softwareSetUpdateSchedule(String softwareSetUpdateSchedule)

An option to define if software updates should be applied within a maintenance window.

Parameters:

softwareSetUpdateSchedule - An option to define if software updates should be applied within a maintenance window.

Returns:

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

See Also:

• SoftwareSetUpdateSchedule
• SoftwareSetUpdateSchedule

softwareSetUpdateSchedule

UpdateEnvironmentRequest.Builder softwareSetUpdateSchedule(SoftwareSetUpdateSchedule softwareSetUpdateSchedule)

An option to define if software updates should be applied within a maintenance window.

Parameters:

softwareSetUpdateSchedule - An option to define if software updates should be applied within a maintenance window.

Returns:

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

See Also:

• SoftwareSetUpdateSchedule
• SoftwareSetUpdateSchedule

maintenanceWindow

UpdateEnvironmentRequest.Builder maintenanceWindow(MaintenanceWindow maintenanceWindow)

A specification for a time window to apply software updates.

Parameters:

maintenanceWindow - A specification for a time window to apply software updates.

Returns:

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

maintenanceWindow

default UpdateEnvironmentRequest.Builder maintenanceWindow(Consumer<MaintenanceWindow.Builder> maintenanceWindow)

A specification for a time window to apply software updates.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to maintenanceWindow(MaintenanceWindow).

Parameters:

maintenanceWindow - a consumer that will call methods on MaintenanceWindow.Builder

Returns:

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

See Also:

• maintenanceWindow(MaintenanceWindow)

softwareSetUpdateMode

UpdateEnvironmentRequest.Builder softwareSetUpdateMode(String softwareSetUpdateMode)

An option to define which software updates to apply.

Parameters:

softwareSetUpdateMode - An option to define which software updates to apply.

Returns:

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

See Also:

• SoftwareSetUpdateMode
• SoftwareSetUpdateMode

softwareSetUpdateMode

UpdateEnvironmentRequest.Builder softwareSetUpdateMode(SoftwareSetUpdateMode softwareSetUpdateMode)

An option to define which software updates to apply.

Parameters:

softwareSetUpdateMode - An option to define which software updates to apply.

Returns:

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

See Also:

• SoftwareSetUpdateMode
• SoftwareSetUpdateMode

desiredSoftwareSetId

UpdateEnvironmentRequest.Builder desiredSoftwareSetId(String desiredSoftwareSetId)

The ID of the software set to apply.

Parameters:

desiredSoftwareSetId - The ID of the software set to apply.

Returns:

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

deviceCreationTags

UpdateEnvironmentRequest.Builder deviceCreationTags(Map<String,String> deviceCreationTags)

A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.

Parameters:

deviceCreationTags - A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.

Returns:

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

overrideConfiguration

UpdateEnvironmentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateEnvironmentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.