Struct ImageRecipe

#[non_exhaustive]
pub struct ImageRecipe {

    pub arn: Option<String>,
    pub type: Option<ImageType>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub platform: Option<Platform>,
    pub owner: Option<String>,
    pub version: Option<String>,
    pub components: Option<Vec<ComponentConfiguration>>,
    pub parent_image: Option<String>,
    pub block_device_mappings: Option<Vec<InstanceBlockDeviceMapping>>,
    pub date_created: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub working_directory: Option<String>,
    pub additional_instance_configuration: Option<AdditionalInstanceConfiguration>,
}

An image recipe.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

arn: Option<String>

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

type: Option<ImageType>

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

name: Option<String>

The name of the image recipe.

description: Option<String>

The description of the image recipe.

platform: Option<Platform>

The platform of the image recipe.

owner: Option<String>

The owner of the image recipe.

version: Option<String>

The version of the image recipe.

components: Option<Vec<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.

parent_image: Option<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

block_device_mappings: Option<Vec<InstanceBlockDeviceMapping>>

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

date_created: Option<String>

The date on which this image recipe was created.

tags: Option<HashMap<String, String>>

The tags of the image recipe.

working_directory: Option<String>

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

additional_instance_configuration: Option<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.

Implementations

impl ImageRecipe

pub fn arn(&self) -> Option<&str>

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

pub fn type(&self) -> Option<&ImageType>

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

pub fn name(&self) -> Option<&str>

The name of the image recipe.

pub fn description(&self) -> Option<&str>

The description of the image recipe.

pub fn platform(&self) -> Option<&Platform>

The platform of the image recipe.

pub fn owner(&self) -> Option<&str>

The owner of the image recipe.

pub fn version(&self) -> Option<&str>

The version of the image recipe.

pub fn components(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .components.is_none().

pub fn parent_image(&self) -> Option<&str>

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

pub fn block_device_mappings(&self) -> &[InstanceBlockDeviceMapping]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .block_device_mappings.is_none().

pub fn date_created(&self) -> Option<&str>

The date on which this image recipe was created.

pub fn tags(&self) -> Option<&HashMap<String, String>>

The tags of the image recipe.

pub fn working_directory(&self) -> Option<&str>

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

pub fn additional_instance_configuration( &self, ) -> Option<&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.

impl ImageRecipe

pub fn builder() -> ImageRecipeBuilder

Creates a new builder-style object to manufacture ImageRecipe.

Trait Implementations

impl Clone for ImageRecipe

fn clone(&self) -> ImageRecipe

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ImageRecipe

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ImageRecipe

fn eq(&self, other: &ImageRecipe) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ImageRecipe