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)


2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end

#container_recipeTypes::ContainerRecipe

The recipe that is used to create an Image Builder container image.



2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end

#date_createdString

The date on which this image was created.

Returns:

  • (String)


2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end

#distribution_configurationTypes::DistributionConfiguration

The distribution configuration used when creating this image.



2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end

#enhanced_image_metadata_enabledBoolean

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

Returns:

  • (Boolean)


2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end

#image_recipeTypes::ImageRecipe

The image recipe used when creating the image.

Returns:



2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end

#image_tests_configurationTypes::ImageTestsConfiguration

The image tests configuration used when creating this image.



2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end

#infrastructure_configurationTypes::InfrastructureConfiguration

The infrastructure used when creating this image.



2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the image.

Returns:

  • (String)


2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end

#os_versionString

The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

Returns:

  • (String)


2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end

#output_resourcesTypes::OutputResources

The output resources produced when creating this image.



2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end

#platformString

The platform of the image.

Returns:

  • (String)


2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end

#source_pipeline_arnString

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

Returns:

  • (String)


2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end

#source_pipeline_nameString

The name of the image pipeline that created this image.

Returns:

  • (String)


2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end

#stateTypes::ImageState

The state of the image.

Returns:



2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags of the image.

Returns:

  • (Hash<String,String>)


2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

Specifies whether this is an AMI or container image.

Returns:

  • (String)


2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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


2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2903

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)
  SENSITIVE = []
  include Aws::Structure
end