#[non_exhaustive]pub struct ImageRecipeBuilder { /* private fields */ }
Expand description
A builder for ImageRecipe
.
Implementations§
Source§impl ImageRecipeBuilder
impl ImageRecipeBuilder
Sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the image recipe.
Sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the image recipe.
Sourcepub fn type(self, input: ImageType) -> Self
pub fn type(self, input: ImageType) -> Self
Specifies which type of image is created by the recipe - an AMI or a container image.
Sourcepub fn set_type(self, input: Option<ImageType>) -> Self
pub fn set_type(self, input: Option<ImageType>) -> Self
Specifies which type of image is created by the recipe - an AMI or a container image.
Sourcepub fn get_type(&self) -> &Option<ImageType>
pub fn get_type(&self) -> &Option<ImageType>
Specifies which type of image is created by the recipe - an AMI or a container image.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the image recipe.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the image recipe.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the image recipe.
Sourcepub fn set_platform(self, input: Option<Platform>) -> Self
pub fn set_platform(self, input: Option<Platform>) -> Self
The platform of the image recipe.
Sourcepub fn get_platform(&self) -> &Option<Platform>
pub fn get_platform(&self) -> &Option<Platform>
The platform of the image recipe.
Sourcepub fn set_version(self, input: Option<String>) -> Self
pub fn set_version(self, input: Option<String>) -> Self
The version of the image recipe.
Sourcepub fn get_version(&self) -> &Option<String>
pub fn get_version(&self) -> &Option<String>
The version of the image recipe.
Sourcepub fn components(self, input: ComponentConfiguration) -> Self
pub fn components(self, input: ComponentConfiguration) -> Self
Appends an item to components
.
To override the contents of this collection use set_components
.
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.
Sourcepub fn set_components(self, input: Option<Vec<ComponentConfiguration>>) -> Self
pub fn set_components(self, input: Option<Vec<ComponentConfiguration>>) -> Self
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.
Sourcepub fn get_components(&self) -> &Option<Vec<ComponentConfiguration>>
pub fn get_components(&self) -> &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.
Sourcepub fn parent_image(self, input: impl Into<String>) -> Self
pub fn parent_image(self, input: impl Into<String>) -> Self
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
Sourcepub fn set_parent_image(self, input: Option<String>) -> Self
pub fn set_parent_image(self, input: Option<String>) -> Self
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
Sourcepub fn get_parent_image(&self) -> &Option<String>
pub fn get_parent_image(&self) -> &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
Sourcepub fn block_device_mappings(self, input: InstanceBlockDeviceMapping) -> Self
pub fn block_device_mappings(self, input: InstanceBlockDeviceMapping) -> Self
Appends an item to block_device_mappings
.
To override the contents of this collection use set_block_device_mappings
.
The block device mappings to apply when creating images from this recipe.
Sourcepub fn set_block_device_mappings(
self,
input: Option<Vec<InstanceBlockDeviceMapping>>,
) -> Self
pub fn set_block_device_mappings( self, input: Option<Vec<InstanceBlockDeviceMapping>>, ) -> Self
The block device mappings to apply when creating images from this recipe.
Sourcepub fn get_block_device_mappings(
&self,
) -> &Option<Vec<InstanceBlockDeviceMapping>>
pub fn get_block_device_mappings( &self, ) -> &Option<Vec<InstanceBlockDeviceMapping>>
The block device mappings to apply when creating images from this recipe.
Sourcepub fn date_created(self, input: impl Into<String>) -> Self
pub fn date_created(self, input: impl Into<String>) -> Self
The date on which this image recipe was created.
Sourcepub fn set_date_created(self, input: Option<String>) -> Self
pub fn set_date_created(self, input: Option<String>) -> Self
The date on which this image recipe was created.
Sourcepub fn get_date_created(&self) -> &Option<String>
pub fn get_date_created(&self) -> &Option<String>
The date on which this image recipe was created.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
The tags of the image recipe.
The tags of the image recipe.
The tags of the image recipe.
Sourcepub fn working_directory(self, input: impl Into<String>) -> Self
pub fn working_directory(self, input: impl Into<String>) -> Self
The working directory to be used during build and test workflows.
Sourcepub fn set_working_directory(self, input: Option<String>) -> Self
pub fn set_working_directory(self, input: Option<String>) -> Self
The working directory to be used during build and test workflows.
Sourcepub fn get_working_directory(&self) -> &Option<String>
pub fn get_working_directory(&self) -> &Option<String>
The working directory to be used during build and test workflows.
Sourcepub fn additional_instance_configuration(
self,
input: AdditionalInstanceConfiguration,
) -> Self
pub fn additional_instance_configuration( self, input: AdditionalInstanceConfiguration, ) -> Self
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.
Sourcepub fn set_additional_instance_configuration(
self,
input: Option<AdditionalInstanceConfiguration>,
) -> Self
pub fn set_additional_instance_configuration( self, input: Option<AdditionalInstanceConfiguration>, ) -> Self
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.
Sourcepub fn get_additional_instance_configuration(
&self,
) -> &Option<AdditionalInstanceConfiguration>
pub fn get_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.
Sourcepub fn build(self) -> ImageRecipe
pub fn build(self) -> ImageRecipe
Consumes the builder and constructs a ImageRecipe
.
Trait Implementations§
Source§impl Clone for ImageRecipeBuilder
impl Clone for ImageRecipeBuilder
Source§fn clone(&self) -> ImageRecipeBuilder
fn clone(&self) -> ImageRecipeBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ImageRecipeBuilder
impl Debug for ImageRecipeBuilder
Source§impl Default for ImageRecipeBuilder
impl Default for ImageRecipeBuilder
Source§fn default() -> ImageRecipeBuilder
fn default() -> ImageRecipeBuilder
Source§impl PartialEq for ImageRecipeBuilder
impl PartialEq for ImageRecipeBuilder
impl StructuralPartialEq for ImageRecipeBuilder
Auto Trait Implementations§
impl Freeze for ImageRecipeBuilder
impl RefUnwindSafe for ImageRecipeBuilder
impl Send for ImageRecipeBuilder
impl Sync for ImageRecipeBuilder
impl Unpin for ImageRecipeBuilder
impl UnwindSafe for ImageRecipeBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);