Class: Aws::Imagebuilder::Types::ContainerRecipe
- Inherits:
-
Struct
- Object
- Struct
- Aws::Imagebuilder::Types::ContainerRecipe
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-imagebuilder/types.rb
Overview
A container recipe.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#arn ⇒ String
The Amazon Resource Name (ARN) of the container recipe.
-
#components ⇒ Array<Types::ComponentConfiguration>
Build and test components that are included in the container recipe.
-
#container_type ⇒ String
Specifies the type of container, such as Docker.
-
#date_created ⇒ String
The date when this container recipe was created.
-
#description ⇒ String
The description of the container recipe.
-
#dockerfile_template_data ⇒ String
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.
-
#encrypted ⇒ Boolean
A flag that indicates if the target container is encrypted.
-
#instance_configuration ⇒ Types::InstanceConfiguration
A group of options that can be used to configure an instance for building and testing container images.
-
#kms_key_id ⇒ String
Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
-
#name ⇒ String
The name of the container recipe.
-
#owner ⇒ String
The owner of the container recipe.
-
#parent_image ⇒ String
The base image for the container recipe.
-
#platform ⇒ String
The system platform for the container, such as Windows or Linux.
-
#tags ⇒ Hash<String,String>
Tags that are attached to the container recipe.
-
#target_repository ⇒ Types::TargetContainerRepository
The destination repository for the container image.
-
#version ⇒ String
The semantic version of the container recipe.
-
#working_directory ⇒ String
The working directory for use during build and test workflows.
Instance Attribute Details
#arn ⇒ String
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.
-
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.
</note>
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |
#components ⇒ Array<Types::ComponentConfiguration>
Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |
#container_type ⇒ String
Specifies the type of container, such as Docker.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |
#date_created ⇒ String
The date when this container recipe was created.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description of the container recipe.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |
#dockerfile_template_data ⇒ String
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.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |
#encrypted ⇒ Boolean
A flag that indicates if the target container is encrypted.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |
#instance_configuration ⇒ Types::InstanceConfiguration
A group of options that can be used to configure an instance for building and testing container images.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |
#kms_key_id ⇒ String
Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the container recipe.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |
#owner ⇒ String
The owner of the container recipe.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |
#parent_image ⇒ String
The base image for the container recipe.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |
#platform ⇒ String
The system platform for the container, such as Windows or Linux.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<String,String>
Tags that are attached to the container recipe.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |
#target_repository ⇒ Types::TargetContainerRepository
The destination repository for the container image.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |
#version ⇒ String
The semantic version of the container recipe.
<note markdown=“1”> 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.
</note>
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |
#working_directory ⇒ String
The working directory for use during build and test workflows.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
# File 'lib/aws-sdk-imagebuilder/types.rb', line 845 class ContainerRecipe < Struct.new( :arn, :container_type, :name, :description, :platform, :owner, :version, :components, :instance_configuration, :dockerfile_template_data, :kms_key_id, :encrypted, :parent_image, :date_created, :tags, :working_directory, :target_repository) SENSITIVE = [] include Aws::Structure end |