@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Image extends Object implements Serializable, Cloneable, StructuredPojo
An Image Builder image. You must specify exactly one recipe for the image – either a container recipe (
containerRecipe
), which creates a container image, or an image recipe (imageRecipe
), which
creates an AMI.
Constructor and Description |
---|
Image() |
Modifier and Type | Method and Description |
---|---|
Image |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
Image |
clearTagsEntries()
Removes all the entries added into Tags.
|
Image |
clone() |
boolean |
equals(Object obj) |
String |
getArn()
The Amazon Resource Name (ARN) of the image.
|
String |
getBuildType()
Indicates the type of build that created this image.
|
ContainerRecipe |
getContainerRecipe()
The recipe that is used to create an Image Builder container image.
|
String |
getDateCreated()
The date on which this image was created.
|
DistributionConfiguration |
getDistributionConfiguration()
The distribution configuration used when creating this image.
|
Boolean |
getEnhancedImageMetadataEnabled()
Collects additional information about the image being created, including the operating system (OS) version and
package list.
|
ImageRecipe |
getImageRecipe()
The image recipe used when creating the image.
|
ImageTestsConfiguration |
getImageTestsConfiguration()
The image tests configuration used when creating this image.
|
InfrastructureConfiguration |
getInfrastructureConfiguration()
The infrastructure used when creating this image.
|
String |
getName()
The name of the image.
|
String |
getOsVersion()
The operating system version of the instance.
|
OutputResources |
getOutputResources()
The output resources produced when creating this image.
|
String |
getPlatform()
The platform of the image.
|
String |
getSourcePipelineArn()
The Amazon Resource Name (ARN) of the image pipeline that created this image.
|
String |
getSourcePipelineName()
The name of the image pipeline that created this image.
|
ImageState |
getState()
The state of the image.
|
Map<String,String> |
getTags()
The tags of the image.
|
String |
getType()
Specifies whether this is an AMI or container image.
|
String |
getVersion()
The semantic version of the image.
|
int |
hashCode() |
Boolean |
isEnhancedImageMetadataEnabled()
Collects additional information about the image being created, including the operating system (OS) version and
package list.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setArn(String arn)
The Amazon Resource Name (ARN) of the image.
|
void |
setBuildType(String buildType)
Indicates the type of build that created this image.
|
void |
setContainerRecipe(ContainerRecipe containerRecipe)
The recipe that is used to create an Image Builder container image.
|
void |
setDateCreated(String dateCreated)
The date on which this image was created.
|
void |
setDistributionConfiguration(DistributionConfiguration distributionConfiguration)
The distribution configuration used when creating this image.
|
void |
setEnhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)
Collects additional information about the image being created, including the operating system (OS) version and
package list.
|
void |
setImageRecipe(ImageRecipe imageRecipe)
The image recipe used when creating the image.
|
void |
setImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)
The image tests configuration used when creating this image.
|
void |
setInfrastructureConfiguration(InfrastructureConfiguration infrastructureConfiguration)
The infrastructure used when creating this image.
|
void |
setName(String name)
The name of the image.
|
void |
setOsVersion(String osVersion)
The operating system version of the instance.
|
void |
setOutputResources(OutputResources outputResources)
The output resources produced when creating this image.
|
void |
setPlatform(String platform)
The platform of the image.
|
void |
setSourcePipelineArn(String sourcePipelineArn)
The Amazon Resource Name (ARN) of the image pipeline that created this image.
|
void |
setSourcePipelineName(String sourcePipelineName)
The name of the image pipeline that created this image.
|
void |
setState(ImageState state)
The state of the image.
|
void |
setTags(Map<String,String> tags)
The tags of the image.
|
void |
setType(String type)
Specifies whether this is an AMI or container image.
|
void |
setVersion(String version)
The semantic version of the image.
|
String |
toString()
Returns a string representation of this object.
|
Image |
withArn(String arn)
The Amazon Resource Name (ARN) of the image.
|
Image |
withBuildType(BuildType buildType)
Indicates the type of build that created this image.
|
Image |
withBuildType(String buildType)
Indicates the type of build that created this image.
|
Image |
withContainerRecipe(ContainerRecipe containerRecipe)
The recipe that is used to create an Image Builder container image.
|
Image |
withDateCreated(String dateCreated)
The date on which this image was created.
|
Image |
withDistributionConfiguration(DistributionConfiguration distributionConfiguration)
The distribution configuration used when creating this image.
|
Image |
withEnhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)
Collects additional information about the image being created, including the operating system (OS) version and
package list.
|
Image |
withImageRecipe(ImageRecipe imageRecipe)
The image recipe used when creating the image.
|
Image |
withImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)
The image tests configuration used when creating this image.
|
Image |
withInfrastructureConfiguration(InfrastructureConfiguration infrastructureConfiguration)
The infrastructure used when creating this image.
|
Image |
withName(String name)
The name of the image.
|
Image |
withOsVersion(String osVersion)
The operating system version of the instance.
|
Image |
withOutputResources(OutputResources outputResources)
The output resources produced when creating this image.
|
Image |
withPlatform(Platform platform)
The platform of the image.
|
Image |
withPlatform(String platform)
The platform of the image.
|
Image |
withSourcePipelineArn(String sourcePipelineArn)
The Amazon Resource Name (ARN) of the image pipeline that created this image.
|
Image |
withSourcePipelineName(String sourcePipelineName)
The name of the image pipeline that created this image.
|
Image |
withState(ImageState state)
The state of the image.
|
Image |
withTags(Map<String,String> tags)
The tags of the image.
|
Image |
withType(ImageType type)
Specifies whether this is an AMI or container image.
|
Image |
withType(String type)
Specifies whether this is an AMI or container image.
|
Image |
withVersion(String version)
The semantic version of the image.
|
public void setArn(String arn)
The Amazon Resource Name (ARN) of the image.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
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.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
arn
- The Amazon Resource Name (ARN) of the image. Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
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.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
public String getArn()
The Amazon Resource Name (ARN) of the image.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
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.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
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.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
public Image withArn(String arn)
The Amazon Resource Name (ARN) of the image.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
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.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
arn
- The Amazon Resource Name (ARN) of the image. Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
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.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
public void setType(String type)
Specifies whether this is an AMI or container image.
type
- Specifies whether this is an AMI or container image.ImageType
public String getType()
Specifies whether this is an AMI or container image.
ImageType
public Image withType(String type)
Specifies whether this is an AMI or container image.
type
- Specifies whether this is an AMI or container image.ImageType
public Image withType(ImageType type)
Specifies whether this is an AMI or container image.
type
- Specifies whether this is an AMI or container image.ImageType
public void setName(String name)
The name of the image.
name
- The name of the image.public String getName()
The name of the image.
public Image withName(String name)
The name of the image.
name
- The name of the image.public void setVersion(String version)
The semantic version of the image.
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.
version
- The semantic version of the image. 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.
public String getVersion()
The semantic version of the image.
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.
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.
public Image withVersion(String version)
The semantic version of the image.
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.
version
- The semantic version of the image. 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.
public void setPlatform(String platform)
The platform of the image.
platform
- The platform of the image.Platform
public String getPlatform()
The platform of the image.
Platform
public Image withPlatform(String platform)
The platform of the image.
platform
- The platform of the image.Platform
public Image withPlatform(Platform platform)
The platform of the image.
platform
- The platform of the image.Platform
public void setEnhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
enhancedImageMetadataEnabled
- Collects additional information about the image being created, including the operating system (OS) version
and package list. This information is used to enhance the overall experience of using EC2 Image Builder.
Enabled by default.public Boolean getEnhancedImageMetadataEnabled()
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
public Image withEnhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
enhancedImageMetadataEnabled
- Collects additional information about the image being created, including the operating system (OS) version
and package list. This information is used to enhance the overall experience of using EC2 Image Builder.
Enabled by default.public Boolean isEnhancedImageMetadataEnabled()
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
public void setOsVersion(String osVersion)
The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
osVersion
- The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows
Server 2019.public String getOsVersion()
The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
public Image withOsVersion(String osVersion)
The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
osVersion
- The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows
Server 2019.public void setState(ImageState state)
The state of the image.
state
- The state of the image.public ImageState getState()
The state of the image.
public Image withState(ImageState state)
The state of the image.
state
- The state of the image.public void setImageRecipe(ImageRecipe imageRecipe)
The image recipe used when creating the image.
imageRecipe
- The image recipe used when creating the image.public ImageRecipe getImageRecipe()
The image recipe used when creating the image.
public Image withImageRecipe(ImageRecipe imageRecipe)
The image recipe used when creating the image.
imageRecipe
- The image recipe used when creating the image.public void setContainerRecipe(ContainerRecipe containerRecipe)
The recipe that is used to create an Image Builder container image.
containerRecipe
- The recipe that is used to create an Image Builder container image.public ContainerRecipe getContainerRecipe()
The recipe that is used to create an Image Builder container image.
public Image withContainerRecipe(ContainerRecipe containerRecipe)
The recipe that is used to create an Image Builder container image.
containerRecipe
- The recipe that is used to create an Image Builder container image.public void setSourcePipelineName(String sourcePipelineName)
The name of the image pipeline that created this image.
sourcePipelineName
- The name of the image pipeline that created this image.public String getSourcePipelineName()
The name of the image pipeline that created this image.
public Image withSourcePipelineName(String sourcePipelineName)
The name of the image pipeline that created this image.
sourcePipelineName
- The name of the image pipeline that created this image.public void setSourcePipelineArn(String sourcePipelineArn)
The Amazon Resource Name (ARN) of the image pipeline that created this image.
sourcePipelineArn
- The Amazon Resource Name (ARN) of the image pipeline that created this image.public String getSourcePipelineArn()
The Amazon Resource Name (ARN) of the image pipeline that created this image.
public Image withSourcePipelineArn(String sourcePipelineArn)
The Amazon Resource Name (ARN) of the image pipeline that created this image.
sourcePipelineArn
- The Amazon Resource Name (ARN) of the image pipeline that created this image.public void setInfrastructureConfiguration(InfrastructureConfiguration infrastructureConfiguration)
The infrastructure used when creating this image.
infrastructureConfiguration
- The infrastructure used when creating this image.public InfrastructureConfiguration getInfrastructureConfiguration()
The infrastructure used when creating this image.
public Image withInfrastructureConfiguration(InfrastructureConfiguration infrastructureConfiguration)
The infrastructure used when creating this image.
infrastructureConfiguration
- The infrastructure used when creating this image.public void setDistributionConfiguration(DistributionConfiguration distributionConfiguration)
The distribution configuration used when creating this image.
distributionConfiguration
- The distribution configuration used when creating this image.public DistributionConfiguration getDistributionConfiguration()
The distribution configuration used when creating this image.
public Image withDistributionConfiguration(DistributionConfiguration distributionConfiguration)
The distribution configuration used when creating this image.
distributionConfiguration
- The distribution configuration used when creating this image.public void setImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)
The image tests configuration used when creating this image.
imageTestsConfiguration
- The image tests configuration used when creating this image.public ImageTestsConfiguration getImageTestsConfiguration()
The image tests configuration used when creating this image.
public Image withImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)
The image tests configuration used when creating this image.
imageTestsConfiguration
- The image tests configuration used when creating this image.public void setDateCreated(String dateCreated)
The date on which this image was created.
dateCreated
- The date on which this image was created.public String getDateCreated()
The date on which this image was created.
public Image withDateCreated(String dateCreated)
The date on which this image was created.
dateCreated
- The date on which this image was created.public void setOutputResources(OutputResources outputResources)
The output resources produced when creating this image.
outputResources
- The output resources produced when creating this image.public OutputResources getOutputResources()
The output resources produced when creating this image.
public Image withOutputResources(OutputResources outputResources)
The output resources produced when creating this image.
outputResources
- The output resources produced when creating this image.public void setTags(Map<String,String> tags)
The tags of the image.
tags
- The tags of the image.public Image withTags(Map<String,String> tags)
The tags of the image.
tags
- The tags of the image.public Image clearTagsEntries()
public void setBuildType(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.
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.
BuildType
public String getBuildType()
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.
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.
BuildType
public Image withBuildType(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.
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.
BuildType
public Image withBuildType(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.
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.
BuildType
public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.