Interface CreateEnvironmentRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>,SdkBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>,SdkPojo,SdkRequest.Builder,WorkSpacesThinClientRequest.Builder
- Enclosing class:
- CreateEnvironmentRequest
public static interface CreateEnvironmentRequest.Builder extends WorkSpacesThinClientRequest.Builder, SdkPojo, CopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CreateEnvironmentRequest.BuilderclientToken(String clientToken)Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.CreateEnvironmentRequest.BuilderdesiredSoftwareSetId(String desiredSoftwareSetId)The ID of the software set to apply.CreateEnvironmentRequest.BuilderdesktopArn(String desktopArn)The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.CreateEnvironmentRequest.BuilderdesktopEndpoint(String desktopEndpoint)The URL for the identity provider login (only for environments that use AppStream 2.0).CreateEnvironmentRequest.BuilderdeviceCreationTags(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.CreateEnvironmentRequest.BuilderkmsKeyArn(String kmsKeyArn)The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.default CreateEnvironmentRequest.BuildermaintenanceWindow(Consumer<MaintenanceWindow.Builder> maintenanceWindow)A specification for a time window to apply software updates.CreateEnvironmentRequest.BuildermaintenanceWindow(MaintenanceWindow maintenanceWindow)A specification for a time window to apply software updates.CreateEnvironmentRequest.Buildername(String name)The name for the environment.CreateEnvironmentRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateEnvironmentRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateEnvironmentRequest.BuildersoftwareSetUpdateMode(String softwareSetUpdateMode)An option to define which software updates to apply.CreateEnvironmentRequest.BuildersoftwareSetUpdateMode(SoftwareSetUpdateMode softwareSetUpdateMode)An option to define which software updates to apply.CreateEnvironmentRequest.BuildersoftwareSetUpdateSchedule(String softwareSetUpdateSchedule)An option to define if software updates should be applied within a maintenance window.CreateEnvironmentRequest.BuildersoftwareSetUpdateSchedule(SoftwareSetUpdateSchedule softwareSetUpdateSchedule)An option to define if software updates should be applied within a maintenance window.CreateEnvironmentRequest.Buildertags(Map<String,String> tags)A map of the key-value pairs of the tag or tags to assign to the resource.-
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 Detail
-
name
CreateEnvironmentRequest.Builder name(String name)
The name for the environment.
- Parameters:
name- The name for the environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
desktopArn
CreateEnvironmentRequest.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
CreateEnvironmentRequest.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
CreateEnvironmentRequest.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
CreateEnvironmentRequest.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
CreateEnvironmentRequest.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 CreateEnvironmentRequest.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 theMaintenanceWindow.Builderavoiding the need to create one manually viaMaintenanceWindow.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tomaintenanceWindow(MaintenanceWindow).- Parameters:
maintenanceWindow- a consumer that will call methods onMaintenanceWindow.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
maintenanceWindow(MaintenanceWindow)
-
softwareSetUpdateMode
CreateEnvironmentRequest.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
CreateEnvironmentRequest.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
CreateEnvironmentRequest.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.
-
kmsKeyArn
CreateEnvironmentRequest.Builder kmsKeyArn(String kmsKeyArn)
The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.
- Parameters:
kmsKeyArn- The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
CreateEnvironmentRequest.Builder clientToken(String clientToken)
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with anIdempotentParameterMismatcherror.- Parameters:
clientToken- Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with anIdempotentParameterMismatcherror.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateEnvironmentRequest.Builder tags(Map<String,String> tags)
A map of the key-value pairs of the tag or tags to assign to the resource.
- Parameters:
tags- A map of the key-value pairs of the tag or tags to assign to the resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deviceCreationTags
CreateEnvironmentRequest.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
CreateEnvironmentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateEnvironmentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-