Class: Aws::Imagebuilder::Types::Image

Inherits:

Struct

Object
Struct
Aws::Imagebuilder::Types::Image

show all

Defined in:: gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#arn ⇒ String
The Amazon Resource Name (ARN) of the image.
#build_type ⇒ String
Indicates the type of build that created this image.
#container_recipe ⇒ Types::ContainerRecipe
For container images, this is the container recipe that Image Builder used to create the image.
#date_created ⇒ String
The date on which Image Builder created this image.
#distribution_configuration ⇒ Types::DistributionConfiguration
The distribution configuration that Image Builder used to create this image.
#enhanced_image_metadata_enabled ⇒ Boolean
Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
#image_recipe ⇒ Types::ImageRecipe
For images that distribute an AMI, this is the image recipe that Image Builder used to create the image.
#image_source ⇒ String
The origin of the base image that Image Builder used to build this image.
#image_tests_configuration ⇒ Types::ImageTestsConfiguration
The image tests that ran when that Image Builder created this image.
#infrastructure_configuration ⇒ Types::InfrastructureConfiguration
The infrastructure that Image Builder used to create this image.
#name ⇒ String
The name of the image.
#os_version ⇒ String
The operating system version for instances that launch from this image.
#output_resources ⇒ Types::OutputResources
The output resources that Image Builder produces for this image.
#platform ⇒ String
The image operating system platform, such as Linux or Windows.
#source_pipeline_arn ⇒ String
The Amazon Resource Name (ARN) of the image pipeline that created this image.
#source_pipeline_name ⇒ String
The name of the image pipeline that created this image.
#state ⇒ Types::ImageState
The state of the image.
#tags ⇒ Hash<String,String>
The tags that apply to this image.
#type ⇒ String
Specifies whether this image produces an AMI or a container image.
#version ⇒ String
The semantic version of the image.

Instance Attribute Details

#arn ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#build_type ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#container_recipe ⇒ `Types::ContainerRecipe`

For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.

Returns:

(Types::ContainerRecipe)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#date_created ⇒ `String`

The date on which Image Builder created this image.

Returns:

(String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#distribution_configuration ⇒ `Types::DistributionConfiguration`

The distribution configuration that Image Builder used to create this image.

Returns:

(Types::DistributionConfiguration)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#enhanced_image_metadata_enabled ⇒ `Boolean`

Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.

Returns:

(Boolean)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#image_recipe ⇒ `Types::ImageRecipe`

For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.

Returns:

(Types::ImageRecipe)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#image_source ⇒ `String`

The origin of the base image that Image Builder used to build this image.

Returns:

(String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#image_tests_configuration ⇒ `Types::ImageTestsConfiguration`

The image tests that ran when that Image Builder created this image.

Returns:

(Types::ImageTestsConfiguration)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#infrastructure_configuration ⇒ `Types::InfrastructureConfiguration`

The infrastructure that Image Builder used to create this image.

Returns:

(Types::InfrastructureConfiguration)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the image.

Returns:

(String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#os_version ⇒ `String`

The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

Returns:

(String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#output_resources ⇒ `Types::OutputResources`

The output resources that Image Builder produces for this image.

Returns:

(Types::OutputResources)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#platform ⇒ `String`

The image operating system platform, such as Linux or Windows.

Returns:

(String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#source_pipeline_arn ⇒ `String`

The Amazon Resource Name (ARN) of the image pipeline that created this image.

Returns:

(String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#source_pipeline_name ⇒ `String`

The name of the image pipeline that created this image.

Returns:

(String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ `Types::ImageState`

The state of the image.

Returns:

(Types::ImageState)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

The tags that apply to this image.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ `String`

Specifies whether this image produces an AMI or a container image.

Returns:

(String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ `String`

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³⁰-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)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2584

class Image < Struct.new(
  :arn,
  :type,
  :name,
  :version,
  :platform,
  :enhanced_image_metadata_enabled,
  :os_version,
  :state,
  :image_recipe,
  :container_recipe,
  :source_pipeline_name,
  :source_pipeline_arn,
  :infrastructure_configuration,
  :distribution_configuration,
  :image_tests_configuration,
  :date_created,
  :output_resources,
  :tags,
  :build_type,
  :image_source)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Imagebuilder::Types::Image

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

#build_type ⇒ String

#container_recipe ⇒ Types::ContainerRecipe

#date_created ⇒ String

#distribution_configuration ⇒ Types::DistributionConfiguration

#enhanced_image_metadata_enabled ⇒ Boolean

#image_recipe ⇒ Types::ImageRecipe

#image_source ⇒ String

#image_tests_configuration ⇒ Types::ImageTestsConfiguration

#infrastructure_configuration ⇒ Types::InfrastructureConfiguration

#name ⇒ String

#os_version ⇒ String

#output_resources ⇒ Types::OutputResources

#platform ⇒ String

#source_pipeline_arn ⇒ String

#source_pipeline_name ⇒ String

#state ⇒ Types::ImageState

#tags ⇒ Hash<String,String>

#type ⇒ String

#version ⇒ String

#arn ⇒ `String`

#build_type ⇒ `String`

#container_recipe ⇒ `Types::ContainerRecipe`

#date_created ⇒ `String`

#distribution_configuration ⇒ `Types::DistributionConfiguration`

#enhanced_image_metadata_enabled ⇒ `Boolean`

#image_recipe ⇒ `Types::ImageRecipe`

#image_source ⇒ `String`

#image_tests_configuration ⇒ `Types::ImageTestsConfiguration`

#infrastructure_configuration ⇒ `Types::InfrastructureConfiguration`

#name ⇒ `String`

#os_version ⇒ `String`

#output_resources ⇒ `Types::OutputResources`

#platform ⇒ `String`

#source_pipeline_arn ⇒ `String`

#source_pipeline_name ⇒ `String`

#state ⇒ `Types::ImageState`

#tags ⇒ `Hash<String,String>`

#type ⇒ `String`

#version ⇒ `String`