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

Inherits:
Struct
  • Object
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

Instance Attribute Details

#arnString

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:

  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)


2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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_typeString

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)


2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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_recipeTypes::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.



2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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_createdString

The date on which Image Builder created this image.

Returns:

  • (String)


2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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_configurationTypes::DistributionConfiguration

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



2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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_enabledBoolean

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

Returns:

  • (Boolean)


2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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_recipeTypes::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:



2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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_sourceString

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

Returns:

  • (String)


2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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_configurationTypes::ImageTestsConfiguration

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



2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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_configurationTypes::InfrastructureConfiguration

The infrastructure that Image Builder used to create this image.



2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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

#nameString

The name of the image.

Returns:

  • (String)


2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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_versionString

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)


2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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_resourcesTypes::OutputResources

The output resources that Image Builder produces for this image.



2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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

#platformString

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

Returns:

  • (String)


2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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_arnString

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

Returns:

  • (String)


2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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_nameString

The name of the image pipeline that created this image.

Returns:

  • (String)


2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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

#stateTypes::ImageState

The state of the image.

Returns:



2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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

#tagsHash<String,String>

The tags that apply to this image.

Returns:

  • (Hash<String,String>)


2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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

#typeString

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

Returns:

  • (String)


2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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

#versionString

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


2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
# 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