Interface ImageVersion.Builder

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

  • Method Details

    • arn

      ImageVersion.Builder arn(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • name

      ImageVersion.Builder name(String name)

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

      Parameters:
      name - The name of this specific version of an Image Builder image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      ImageVersion.Builder type(String type)

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

      Parameters:
      type - Specifies whether this image produces an AMI or a container image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      ImageVersion.Builder type(ImageType type)

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

      Parameters:
      type - Specifies whether this image produces an AMI or a container image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • version

      ImageVersion.Builder version(String version)

      The semantic version of the 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. The upper limit is 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: You can 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.

      Parameters:
      version - The semantic version of the 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. The upper limit is 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: You can 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:
      Returns a reference to this object so that method calls can be chained together.

    • platform

      ImageVersion.Builder platform(String platform)

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

      Parameters:
      platform - The operating system platform of the image version, for example "Windows" or "Linux".
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • platform

      ImageVersion.Builder platform(Platform platform)

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

      Parameters:
      platform - The operating system platform of the image version, for example "Windows" or "Linux".
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • osVersion

      ImageVersion.Builder osVersion(String osVersion)

      The operating system version of the image. For example, Amazon Linux 2023 or Microsoft Windows Server 2022.

      Parameters:
      osVersion - The operating system version of the image. For example, Amazon Linux 2023 or Microsoft Windows Server 2022.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • owner

      ImageVersion.Builder owner(String owner)

      The owner of the image version.

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

    • dateCreated

      ImageVersion.Builder dateCreated(String dateCreated)

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

      Parameters:
      dateCreated - The date on which this specific version of the Image Builder image was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • buildType

      ImageVersion.Builder buildType(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • buildType

      ImageVersion.Builder buildType(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • imageSource

      ImageVersion.Builder imageSource(String imageSource)

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

      Parameters:
      imageSource - The origin of the base image that Image Builder used to build this image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • imageSource

      ImageVersion.Builder imageSource(ImageSource imageSource)

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

      Parameters:
      imageSource - The origin of the base image that Image Builder used to build this image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: