class Aws::Imagebuilder::Types::ContainerRecipe

A container recipe.

@!attribute [rw] arn

The Amazon Resource Name (ARN) of the container recipe.

<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] container_type

Specifies the type of container, such as Docker.
@return [String]

@!attribute [rw] name

The name of the container recipe.
@return [String]

@!attribute [rw] description

The description of the container recipe.
@return [String]

@!attribute [rw] platform

The system platform for the container, such as Windows or Linux.
@return [String]

@!attribute [rw] owner

The owner of the container recipe.
@return [String]

@!attribute [rw] version

The semantic version of the container recipe.

<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] components

Components for build and test that are included in the container
recipe.
@return [Array<Types::ComponentConfiguration>]

@!attribute [rw] instance_configuration

A group of options that can be used to configure an instance for
building and testing container images.
@return [Types::InstanceConfiguration]

@!attribute [rw] dockerfile_template_data

Dockerfiles are text documents that are used to build Docker
containers, and ensure that they contain all of the elements
required by the application running inside. The template data
consists of contextual variables where Image Builder places build
information or scripts, based on your container image recipe.
@return [String]

@!attribute [rw] kms_key_id

Identifies which KMS key is used to encrypt the container image for
distribution to the target Region.
@return [String]

@!attribute [rw] encrypted

A flag that indicates if the target container is encrypted.
@return [Boolean]

@!attribute [rw] parent_image

The source image for the container recipe.
@return [String]

@!attribute [rw] date_created

The date when this container recipe was created.
@return [String]

@!attribute [rw] tags

Tags that are attached to the container recipe.
@return [Hash<String,String>]

@!attribute [rw] working_directory

The working directory for use during build and test workflows.
@return [String]

@!attribute [rw] target_repository

The destination repository for the container image.
@return [Types::TargetContainerRepository]

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

Constants

SENSITIVE