Interface CreateEnvironmentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>, SdkBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>, SdkPojo, SdkRequest.Builder, WorkSpacesThinClientRequest.Builder
Enclosing class:
CreateEnvironmentRequest
@Mutable @NotThreadSafe public static interface CreateEnvironmentRequest.Builder extends WorkSpacesThinClientRequest.Builder, SdkPojo, CopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

  • Method Details

    • 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 Secure Browser, or AppStream 2.0.

      Parameters:
      desktopArn - The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, 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

      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:

    • 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 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:

    • 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

      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:

    • 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 an IdempotentParameterMismatch error.

      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 an IdempotentParameterMismatch error.

      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)
      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

      CreateEnvironmentRequest.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.