Class ImageVersion

java.lang.Object
software.amazon.awssdk.services.imagebuilder.model.ImageVersion
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ImageVersion.Builder,ImageVersion>
@Generated("software.amazon.awssdk:codegen") public final class ImageVersion extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ImageVersion.Builder,ImageVersion>

The defining characteristics of a specific version of an Image Builder image.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of a specific version of an Image Builder image.

      Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

      1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.

      2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>

      3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

      Returns:
      The Amazon Resource Name (ARN) of a specific version of an Image Builder image.

      Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

      1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.

      2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>

      3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

    • name

      public final String name()

      The name of this specific version of an Image Builder image.

      Returns:
      The name of this specific version of an Image Builder image.

    • type

      public final ImageType type()

      Specifies whether this image produces an AMI or a container image.

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

      Returns:
      Specifies whether this image produces an AMI or a container image.
      See Also:

    • typeAsString

      public final String typeAsString()

      Specifies whether this image produces an AMI or a container image.

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

      Returns:
      Specifies whether this image produces an AMI or a container image.
      See Also:

    • version

      public final String version()

      Details for a specific version of an Image Builder image. This version follows the semantic version syntax.

      The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

      Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

      Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

      Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

      Returns:
      Details for a specific version of an Image Builder image. This version follows the semantic version syntax.

      The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

      Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

      Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

      Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

    • platform

      public final Platform platform()

      The operating system platform of the image version, for example "Windows" or "Linux".

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

      Returns:
      The operating system platform of the image version, for example "Windows" or "Linux".
      See Also:

    • platformAsString

      public final String platformAsString()

      The operating system platform of the image version, for example "Windows" or "Linux".

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

      Returns:
      The operating system platform of the image version, for example "Windows" or "Linux".
      See Also:

    • osVersion

      public final String osVersion()

      The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

      Returns:
      The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

    • owner

      public final String owner()

      The owner of the image version.

      Returns:
      The owner of the image version.

    • dateCreated

      public final String dateCreated()

      The date on which this specific version of the Image Builder image was created.

      Returns:
      The date on which this specific version of the Image Builder image was created.

    • buildType

      public final BuildType buildType()

      Indicates the type of build that created this image. The build can be initiated in the following ways:

      • USER_INITIATED – A manual pipeline build request.

      • SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

      • IMPORT – A VM import created the image to use as the base image for the recipe.

      • IMPORT_ISO – An ISO disk import created the image.

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

      Returns:
      Indicates the type of build that created this image. The build can be initiated in the following ways:

      • USER_INITIATED – A manual pipeline build request.

      • SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

      • IMPORT – A VM import created the image to use as the base image for the recipe.

      • IMPORT_ISO – An ISO disk import created the image.

      See Also:

    • buildTypeAsString

      public final String buildTypeAsString()

      Indicates the type of build that created this image. The build can be initiated in the following ways:

      • USER_INITIATED – A manual pipeline build request.

      • SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

      • IMPORT – A VM import created the image to use as the base image for the recipe.

      • IMPORT_ISO – An ISO disk import created the image.

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

      Returns:
      Indicates the type of build that created this image. The build can be initiated in the following ways:

      • USER_INITIATED – A manual pipeline build request.

      • SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

      • IMPORT – A VM import created the image to use as the base image for the recipe.

      • IMPORT_ISO – An ISO disk import created the image.

      See Also:

    • imageSource

      public final ImageSource imageSource()

      The origin of the base image that Image Builder used to build this image.

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

      Returns:
      The origin of the base image that Image Builder used to build this image.
      See Also:

    • imageSourceAsString

      public final String imageSourceAsString()

      The origin of the base image that Image Builder used to build this image.

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

      Returns:
      The origin of the base image that Image Builder used to build this image.
      See Also:

    • toBuilder

      public ImageVersion.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<ImageVersion.Builder,ImageVersion>
      Returns:
      a builder for type T

    • builder

      public static ImageVersion.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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