Interface Environment.Builder

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

  • Method Details

    • id

      Environment.Builder id(String id)

      The ID of the environment.

      Parameters:
      id - The ID of the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      Environment.Builder name(String name)

      The name of the environment.

      Parameters:
      name - The name of the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • desktopArn

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

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

    • desktopType

      Environment.Builder desktopType(String desktopType)

      The type of streaming desktop for the environment.

      Parameters:
      desktopType - The type of streaming desktop for the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • desktopType

      Environment.Builder desktopType(DesktopType desktopType)

      The type of streaming desktop for the environment.

      Parameters:
      desktopType - The type of streaming desktop for the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • activationCode

      Environment.Builder activationCode(String activationCode)

      The activation code to register a device to the environment.

      Parameters:
      activationCode - The activation code to register a device to the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • registeredDevicesCount

      Environment.Builder registeredDevicesCount(Integer registeredDevicesCount)

      The number of devices registered to the environment.

      Parameters:
      registeredDevicesCount - The number of devices registered to the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • softwareSetUpdateSchedule

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

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

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

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

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

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

    • pendingSoftwareSetId

      Environment.Builder pendingSoftwareSetId(String pendingSoftwareSetId)

      The ID of the software set that is pending to be installed.

      Parameters:
      pendingSoftwareSetId - The ID of the software set that is pending to be installed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pendingSoftwareSetVersion

      Environment.Builder pendingSoftwareSetVersion(String pendingSoftwareSetVersion)

      The version of the software set that is pending to be installed.

      Parameters:
      pendingSoftwareSetVersion - The version of the software set that is pending to be installed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • softwareSetComplianceStatus

      Environment.Builder softwareSetComplianceStatus(String softwareSetComplianceStatus)

      Describes if the software currently installed on all devices in the environment is a supported version.

      Parameters:
      softwareSetComplianceStatus - Describes if the software currently installed on all devices in the environment is a supported version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • softwareSetComplianceStatus

      Environment.Builder softwareSetComplianceStatus(EnvironmentSoftwareSetComplianceStatus softwareSetComplianceStatus)

      Describes if the software currently installed on all devices in the environment is a supported version.

      Parameters:
      softwareSetComplianceStatus - Describes if the software currently installed on all devices in the environment is a supported version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      Environment.Builder createdAt(Instant createdAt)

      The timestamp of when the environment was created.

      Parameters:
      createdAt - The timestamp of when the environment was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      Environment.Builder updatedAt(Instant updatedAt)

      The timestamp of when the device was updated.

      Parameters:
      updatedAt - The timestamp of when the device was updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      Environment.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the environment.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyArn

      Environment.Builder kmsKeyArn(String kmsKeyArn)

      The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the environment.

      Parameters:
      kmsKeyArn - The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deviceCreationTags

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

      The tag keys and optional values for the newly created devices for this environment.

      Parameters:
      deviceCreationTags - The tag keys and optional values for the newly created devices for this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.