Class CreateEnvironmentRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.workspacesthinclient.model.WorkSpacesThinClientRequest
software.amazon.awssdk.services.workspacesthinclient.model.CreateEnvironmentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateEnvironmentRequest extends WorkSpacesThinClientRequest implements ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

  • Method Details

    • name

      public final String name()

      The name for the environment.

      Returns:
      The name for the environment.

    • desktopArn

      public final String desktopArn()

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

      Returns:
      The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.

    • desktopEndpoint

      public final String desktopEndpoint()

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

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

    • softwareSetUpdateSchedule

      public final SoftwareSetUpdateSchedule softwareSetUpdateSchedule()

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

      If the service returns an enum value that is not available in the current SDK version, softwareSetUpdateSchedule will return SoftwareSetUpdateSchedule.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from softwareSetUpdateScheduleAsString().

      Returns:
      An option to define if software updates should be applied within a maintenance window.
      See Also:

    • softwareSetUpdateScheduleAsString

      public final String softwareSetUpdateScheduleAsString()

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

      If the service returns an enum value that is not available in the current SDK version, softwareSetUpdateSchedule will return SoftwareSetUpdateSchedule.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from softwareSetUpdateScheduleAsString().

      Returns:
      An option to define if software updates should be applied within a maintenance window.
      See Also:

    • maintenanceWindow

      public final MaintenanceWindow maintenanceWindow()

      A specification for a time window to apply software updates.

      Returns:
      A specification for a time window to apply software updates.

    • softwareSetUpdateMode

      public final SoftwareSetUpdateMode softwareSetUpdateMode()

      An option to define which software updates to apply.

      If the service returns an enum value that is not available in the current SDK version, softwareSetUpdateMode will return SoftwareSetUpdateMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from softwareSetUpdateModeAsString().

      Returns:
      An option to define which software updates to apply.
      See Also:

    • softwareSetUpdateModeAsString

      public final String softwareSetUpdateModeAsString()

      An option to define which software updates to apply.

      If the service returns an enum value that is not available in the current SDK version, softwareSetUpdateMode will return SoftwareSetUpdateMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from softwareSetUpdateModeAsString().

      Returns:
      An option to define which software updates to apply.
      See Also:

    • desiredSoftwareSetId

      public final String desiredSoftwareSetId()

      The ID of the software set to apply.

      Returns:
      The ID of the software set to apply.

    • kmsKeyArn

      public final String kmsKeyArn()

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

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

    • clientToken

      public final 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.

      Returns:
      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.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      A map of the key-value pairs of the tag or tags to assign to the resource.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      A map of the key-value pairs of the tag or tags to assign to the resource.

    • hasDeviceCreationTags

      public final boolean hasDeviceCreationTags()
      For responses, this returns true if the service returned a value for the DeviceCreationTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • deviceCreationTags

      public final 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDeviceCreationTags() method.

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

    • toBuilder

      public CreateEnvironmentRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>
      Specified by:
      toBuilder in class WorkSpacesThinClientRequest
      Returns:
      a builder for type T

    • builder

      public static CreateEnvironmentRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateEnvironmentRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.