Class: Aws::Imagebuilder::Types::ImageRecipe

Inherits:

Struct

• Object
• Struct
• Aws::Imagebuilder::Types::ImageRecipe

Includes:

Structure

Defined in:

lib/aws-sdk-imagebuilder/types.rb

Overview

An image recipe.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #additional_instance_configuration ⇒ Types::AdditionalInstanceConfiguration

  Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.

• #ami_tags ⇒ Hash<String,String>

  Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.

• #arn ⇒ String

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

• #block_device_mappings ⇒ Array<Types::InstanceBlockDeviceMapping>

  The block device mappings to apply when creating images from this recipe.

• #components ⇒ Array<Types::ComponentConfiguration>

  The components that are included in the image recipe.

• #date_created ⇒ String

  The date on which this image recipe was created.

• #description ⇒ String

  The description of the image recipe.

• #name ⇒ String

  The name of the image recipe.

• #owner ⇒ String

  The owner of the image recipe.

• #parent_image ⇒ String

  The base image for customizations specified in the image recipe.

• #platform ⇒ String

  The platform of the image recipe.

• #tags ⇒ Hash<String,String>

  The tags of the image recipe.

• #type ⇒ String

  Specifies which type of image is created by the recipe - an AMI or a container image.

• #version ⇒ String

  The version of the image recipe.

• #working_directory ⇒ String

  The working directory to be used during build and test workflows.

Instance Attribute Details

#additional_instance_configuration ⇒ Types::AdditionalInstanceConfiguration

Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.

Returns:

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

class ImageRecipe < Struct.new(
  :arn,
  :type,
  :name,
  :description,
  :platform,
  :owner,
  :version,
  :components,
  :parent_image,
  :block_device_mappings,
  :date_created,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :ami_tags)
  SENSITIVE = []
  include Aws::Structure
end

#ami_tags ⇒ Hash<String,String>

Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.

Returns:

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

class ImageRecipe < Struct.new(
  :arn,
  :type,
  :name,
  :description,
  :platform,
  :owner,
  :version,
  :components,
  :parent_image,
  :block_device_mappings,
  :date_created,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :ami_tags)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

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

Returns:

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

class ImageRecipe < Struct.new(
  :arn,
  :type,
  :name,
  :description,
  :platform,
  :owner,
  :version,
  :components,
  :parent_image,
  :block_device_mappings,
  :date_created,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :ami_tags)
  SENSITIVE = []
  include Aws::Structure
end

#block_device_mappings ⇒ Array<Types::InstanceBlockDeviceMapping>

The block device mappings to apply when creating images from this recipe.

Returns:

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

class ImageRecipe < Struct.new(
  :arn,
  :type,
  :name,
  :description,
  :platform,
  :owner,
  :version,
  :components,
  :parent_image,
  :block_device_mappings,
  :date_created,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :ami_tags)
  SENSITIVE = []
  include Aws::Structure
end

#components ⇒ Array<Types::ComponentConfiguration>

The components that are included in the image recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

Returns:

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

class ImageRecipe < Struct.new(
  :arn,
  :type,
  :name,
  :description,
  :platform,
  :owner,
  :version,
  :components,
  :parent_image,
  :block_device_mappings,
  :date_created,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :ami_tags)
  SENSITIVE = []
  include Aws::Structure
end

#date_created ⇒ String

The date on which this image recipe was created.

Returns:

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

class ImageRecipe < Struct.new(
  :arn,
  :type,
  :name,
  :description,
  :platform,
  :owner,
  :version,
  :components,
  :parent_image,
  :block_device_mappings,
  :date_created,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :ami_tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the image recipe.

Returns:

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

class ImageRecipe < Struct.new(
  :arn,
  :type,
  :name,
  :description,
  :platform,
  :owner,
  :version,
  :components,
  :parent_image,
  :block_device_mappings,
  :date_created,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :ami_tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the image recipe.

Returns:

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

class ImageRecipe < Struct.new(
  :arn,
  :type,
  :name,
  :description,
  :platform,
  :owner,
  :version,
  :components,
  :parent_image,
  :block_device_mappings,
  :date_created,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :ami_tags)
  SENSITIVE = []
  include Aws::Structure
end

#owner ⇒ String

The owner of the image recipe.

Returns:

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

class ImageRecipe < Struct.new(
  :arn,
  :type,
  :name,
  :description,
  :platform,
  :owner,
  :version,
  :components,
  :parent_image,
  :block_device_mappings,
  :date_created,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :ami_tags)
  SENSITIVE = []
  include Aws::Structure
end

#parent_image ⇒ String

The base image for customizations specified in the image recipe. You can specify the parent image using one of the following options:

• AMI ID

• Image Builder image Amazon Resource Name (ARN)

• Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ‘ssm:`, followed by the parameter name or ARN.

• Amazon Web Services Marketplace product ID

Returns:

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

class ImageRecipe < Struct.new(
  :arn,
  :type,
  :name,
  :description,
  :platform,
  :owner,
  :version,
  :components,
  :parent_image,
  :block_device_mappings,
  :date_created,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :ami_tags)
  SENSITIVE = []
  include Aws::Structure
end

#platform ⇒ String

The platform of the image recipe.

Returns:

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

class ImageRecipe < Struct.new(
  :arn,
  :type,
  :name,
  :description,
  :platform,
  :owner,
  :version,
  :components,
  :parent_image,
  :block_device_mappings,
  :date_created,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :ami_tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags of the image recipe.

Returns:

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

class ImageRecipe < Struct.new(
  :arn,
  :type,
  :name,
  :description,
  :platform,
  :owner,
  :version,
  :components,
  :parent_image,
  :block_device_mappings,
  :date_created,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :ami_tags)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

Specifies which type of image is created by the recipe - an AMI or a container image.

Returns:

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

class ImageRecipe < Struct.new(
  :arn,
  :type,
  :name,
  :description,
  :platform,
  :owner,
  :version,
  :components,
  :parent_image,
  :block_device_mappings,
  :date_created,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :ami_tags)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

The version of the image recipe.

Returns:

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

class ImageRecipe < Struct.new(
  :arn,
  :type,
  :name,
  :description,
  :platform,
  :owner,
  :version,
  :components,
  :parent_image,
  :block_device_mappings,
  :date_created,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :ami_tags)
  SENSITIVE = []
  include Aws::Structure
end

#working_directory ⇒ String

The working directory to be used during build and test workflows.

Returns:

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

class ImageRecipe < Struct.new(
  :arn,
  :type,
  :name,
  :description,
  :platform,
  :owner,
  :version,
  :components,
  :parent_image,
  :block_device_mappings,
  :date_created,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :ami_tags)
  SENSITIVE = []
  include Aws::Structure
end