class Aws::Imagebuilder::Types::Image

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.

@!attribute [rw] arn

The Amazon Resource Name (ARN) of the image.

<note markdown="1"> 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:
    &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;

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

 </note>
@return [String]

@!attribute [rw] type

Specifies whether this is an AMI or container image.
@return [String]

@!attribute [rw] name

The name of the image.
@return [String]

@!attribute [rw] version

The semantic version of the image.

<note markdown="1"> The semantic version has four nodes:
&lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. 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, and that is not open for updates.

 **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:** When you retrieve or reference a resource with a
semantic version, you can use wildcards (x) to filter your results.
When you use a wildcard in any node, all nodes to the right of the
first wildcard must also be wildcards. For example, specifying
"1.2.x", or "1.x.x" works to filter list results, but neither
"1.x.2", nor "x.2.x" will work. You do not have to specify the
build - Image Builder automatically uses a wildcard for that, if
applicable.

 </note>
@return [String]

@!attribute [rw] platform

The platform of the image.
@return [String]

@!attribute [rw] enhanced_image_metadata_enabled

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.
@return [Boolean]

@!attribute [rw] os_version

The operating system version of the instance. For example, Amazon
Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
@return [String]

@!attribute [rw] state

The state of the image.
@return [Types::ImageState]

@!attribute [rw] image_recipe

The image recipe used when creating the image.
@return [Types::ImageRecipe]

@!attribute [rw] container_recipe

The recipe that is used to create an Image Builder container image.
@return [Types::ContainerRecipe]

@!attribute [rw] source_pipeline_name

The name of the image pipeline that created this image.
@return [String]

@!attribute [rw] source_pipeline_arn

The Amazon Resource Name (ARN) of the image pipeline that created
this image.
@return [String]

@!attribute [rw] infrastructure_configuration

The infrastructure used when creating this image.
@return [Types::InfrastructureConfiguration]

@!attribute [rw] distribution_configuration

The distribution configuration used when creating this image.
@return [Types::DistributionConfiguration]

@!attribute [rw] image_tests_configuration

The image tests configuration used when creating this image.
@return [Types::ImageTestsConfiguration]

@!attribute [rw] date_created

The date on which this image was created.
@return [String]

@!attribute [rw] output_resources

The output resources produced when creating this image.
@return [Types::OutputResources]

@!attribute [rw] tags

The tags of the image.
@return [Hash<String,String>]

@see docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Image AWS API Documentation

Constants

SENSITIVE