software.amazon.awssdk.services.imagebuilder.model

Interface ImageVersion.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ImageVersion.Builder,ImageVersion>, SdkBuilder<ImageVersion.Builder,ImageVersion>, SdkPojo

Enclosing class:

ImageVersion

public static interface ImageVersion.Builder
extends SdkPojo, CopyableBuilder<ImageVersion.Builder,ImageVersion>

Method Summary

Modifier and Type	Method and Description
ImageVersion.Builder	arn(String arn) The Amazon Resource Name (ARN) of a specific version of an Image Builder image.
ImageVersion.Builder	buildType(BuildType buildType) Indicates the type of build that created this image.
ImageVersion.Builder	buildType(String buildType) Indicates the type of build that created this image.
ImageVersion.Builder	dateCreated(String dateCreated) The date on which this specific version of the Image Builder image was created.
ImageVersion.Builder	name(String name) The name of this specific version of an Image Builder image.
ImageVersion.Builder	osVersion(String osVersion) The operating system version of the Amazon EC2 build instance.
ImageVersion.Builder	owner(String owner) The owner of the image version.
ImageVersion.Builder	platform(Platform platform) The platform of the image version, for example "Windows" or "Linux".
ImageVersion.Builder	platform(String platform) The platform of the image version, for example "Windows" or "Linux".
ImageVersion.Builder	type(ImageType type) Specifies whether this image is an AMI or a container image.
ImageVersion.Builder	type(String type) Specifies whether this image is an AMI or a container image.
ImageVersion.Builder	version(String version) Details for a specific version of an Image Builder image.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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 is an AMI or a container image.

Parameters:

type - Specifies whether this image is an AMI or a container image.

Returns:

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

See Also:

ImageType, ImageType

type

ImageVersion.Builder type(ImageType type)

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

Parameters:

type - Specifies whether this image is an AMI or a container image.

Returns:

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

See Also:

ImageType, ImageType

version

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

Parameters:

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:

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

platform

ImageVersion.Builder platform(String platform)

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

Parameters:

platform - The 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, Platform

platform

ImageVersion.Builder platform(Platform platform)

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

Parameters:

platform - The 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, Platform

osVersion

ImageVersion.Builder osVersion(String osVersion)

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

Parameters:

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

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.

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.

Returns:

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

See Also:

BuildType, BuildType

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.

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.

Returns:

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

See Also:

BuildType, BuildType