Class CreateImportedImageRequest

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

  • Method Details

    • name

      public final String name()

      A unique name for the imported image. The name must be between 1 and 100 characters and can contain letters, numbers, underscores, periods, and hyphens.

      Returns:
      A unique name for the imported image. The name must be between 1 and 100 characters and can contain letters, numbers, underscores, periods, and hyphens.

    • sourceAmiId

      public final String sourceAmiId()

      The ID of the EC2 AMI to import. The AMI must meet specific requirements including Windows Server 2022 Full Base, UEFI boot mode, TPM 2.0 support, and proper drivers.

      Returns:
      The ID of the EC2 AMI to import. The AMI must meet specific requirements including Windows Server 2022 Full Base, UEFI boot mode, TPM 2.0 support, and proper drivers.

    • iamRoleArn

      public final String iamRoleArn()

      The ARN of the IAM role that allows WorkSpaces Applications to access your AMI. The role must have permissions to modify image attributes and describe images, with a trust relationship allowing appstream.amazonaws.com to assume the role.

      Returns:
      The ARN of the IAM role that allows WorkSpaces Applications to access your AMI. The role must have permissions to modify image attributes and describe images, with a trust relationship allowing appstream.amazonaws.com to assume the role.

    • description

      public final String description()

      An optional description for the imported image. The description must match approved regex patterns and can be up to 256 characters.

      Returns:
      An optional description for the imported image. The description must match approved regex patterns and can be up to 256 characters.

    • displayName

      public final String displayName()

      An optional display name for the imported image. The display name must match approved regex patterns and can be up to 100 characters.

      Returns:
      An optional display name for the imported image. The display name must match approved regex patterns and can be up to 100 characters.

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

      The tags to apply to the imported image. Tags help you organize and manage your WorkSpaces Applications resources.

      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:
      The tags to apply to the imported image. Tags help you organize and manage your WorkSpaces Applications resources.

    • runtimeValidationConfig

      public final RuntimeValidationConfig runtimeValidationConfig()

      Configuration for runtime validation of the imported image. When specified, WorkSpaces Applications provisions an instance to test streaming functionality, which helps ensure the image is suitable for use.

      Returns:
      Configuration for runtime validation of the imported image. When specified, WorkSpaces Applications provisions an instance to test streaming functionality, which helps ensure the image is suitable for use.

    • agentSoftwareVersion

      public final AgentSoftwareVersion agentSoftwareVersion()

      The version of the WorkSpaces Applications agent to use for the imported image. Choose CURRENT_LATEST to use the agent version available at the time of import, or ALWAYS_LATEST to automatically update to the latest agent version when new versions are released.

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

      Returns:
      The version of the WorkSpaces Applications agent to use for the imported image. Choose CURRENT_LATEST to use the agent version available at the time of import, or ALWAYS_LATEST to automatically update to the latest agent version when new versions are released.
      See Also:

    • agentSoftwareVersionAsString

      public final String agentSoftwareVersionAsString()

      The version of the WorkSpaces Applications agent to use for the imported image. Choose CURRENT_LATEST to use the agent version available at the time of import, or ALWAYS_LATEST to automatically update to the latest agent version when new versions are released.

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

      Returns:
      The version of the WorkSpaces Applications agent to use for the imported image. Choose CURRENT_LATEST to use the agent version available at the time of import, or ALWAYS_LATEST to automatically update to the latest agent version when new versions are released.
      See Also:

    • hasAppCatalogConfig

      public final boolean hasAppCatalogConfig()
      For responses, this returns true if the service returned a value for the AppCatalogConfig 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.

    • appCatalogConfig

      public final List<ApplicationConfig> appCatalogConfig()

      Configuration for the application catalog of the imported image. This allows you to specify applications available for streaming, including their paths, icons, and launch parameters. This field contains sensitive data.

      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 hasAppCatalogConfig() method.

      Returns:
      Configuration for the application catalog of the imported image. This allows you to specify applications available for streaming, including their paths, icons, and launch parameters. This field contains sensitive data.

    • dryRun

      public final Boolean dryRun()

      When set to true, performs validation checks without actually creating the imported image. Use this to verify your configuration before executing the actual import operation.

      Returns:
      When set to true, performs validation checks without actually creating the imported image. Use this to verify your configuration before executing the actual import operation.

    • toBuilder

      public CreateImportedImageRequest.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<CreateImportedImageRequest.Builder,CreateImportedImageRequest>
      Specified by:
      toBuilder in class AppStreamRequest
      Returns:
      a builder for type T

    • builder

      public static CreateImportedImageRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateImportedImageRequest.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.