Class ImportDiskImageRequest

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

  • Method Details

    • name

      public final String name()

      The name of the image resource that's created from the import.

      Returns:
      The name of the image resource that's created from the import.

    • semanticVersion

      public final String semanticVersion()

      The semantic version to attach to the image that's created during the import process. This version follows the semantic version syntax.

      Returns:
      The semantic version to attach to the image that's created during the import process. This version follows the semantic version syntax.

    • description

      public final String description()

      The description for your disk image import.

      Returns:
      The description for your disk image import.

    • platform

      public final String platform()

      The operating system platform for the imported image. Allowed values include the following: Windows.

      Returns:
      The operating system platform for the imported image. Allowed values include the following: Windows.

    • osVersion

      public final String osVersion()

      The operating system version for the imported image. Allowed values include the following: Microsoft Windows 11.

      Returns:
      The operating system version for the imported image. Allowed values include the following: Microsoft Windows 11.

    • executionRole

      public final String executionRole()

      The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions to import an image from a Microsoft ISO file.

      Returns:
      The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions to import an image from a Microsoft ISO file.

    • infrastructureConfigurationArn

      public final String infrastructureConfigurationArn()

      The Amazon Resource Name (ARN) of the infrastructure configuration resource that's used for launching the EC2 instance on which the ISO image is built.

      Returns:
      The Amazon Resource Name (ARN) of the infrastructure configuration resource that's used for launching the EC2 instance on which the ISO image is built.

    • uri

      public final String uri()

      The uri of the ISO disk file that's stored in Amazon S3.

      Returns:
      The uri of the ISO disk file that's stored in Amazon S3.

    • loggingConfiguration

      public final ImageLoggingConfiguration loggingConfiguration()

      Define logging configuration for the image build process.

      Returns:
      Define logging configuration for the image build process.

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

      Tags that are attached to image resources created from the import.

      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:
      Tags that are attached to image resources created from the import.

    • clientToken

      public final String clientToken()

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      Returns:
      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

    • toBuilder

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

    • builder

      public static ImportDiskImageRequest.Builder builder()

    • serializableBuilderClass

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