Class: Aws::Imagebuilder::Types::ContainerRecipe

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb

Overview

A container recipe.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

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:

  • (String)


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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

#componentsArray<Types::ComponentConfiguration>

Components for build and test that are included in the container recipe.

Returns:



785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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_typeString

Specifies the type of container, such as Docker.

Returns:

  • (String)


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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_createdString

The date when this container recipe was created.

Returns:

  • (String)


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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

#descriptionString

The description of the container recipe.

Returns:

  • (String)


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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_dataString

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.

Returns:

  • (String)


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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

#encryptedBoolean

A flag that indicates if the target container is encrypted.

Returns:

  • (Boolean)


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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_configurationTypes::InstanceConfiguration

A group of options that can be used to configure an instance for building and testing container images.



785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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_idString

Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

Returns:

  • (String)


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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

#nameString

The name of the container recipe.

Returns:

  • (String)


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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

#ownerString

The owner of the container recipe.

Returns:

  • (String)


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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_imageString

The base image for the container recipe.

Returns:

  • (String)


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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

#platformString

The system platform for the container, such as Windows or Linux.

Returns:

  • (String)


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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

#tagsHash<String,String>

Tags that are attached to the container recipe.

Returns:

  • (Hash<String,String>)


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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_repositoryTypes::TargetContainerRepository

The destination repository for the container image.



785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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

#versionString

The semantic version of the container recipe.

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 230-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:

  • (String)


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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_directoryString

The working directory for use during build and test workflows.

Returns:

  • (String)


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 785

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