#[non_exhaustive]pub struct ContainerRecipeBuilder { /* private fields */ }
Expand description
A builder for ContainerRecipe
.
Implementations§
Source§impl ContainerRecipeBuilder
impl ContainerRecipeBuilder
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 container recipe.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
-
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.
-
Version ARNs have only the first three nodes:
. . -
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
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 container recipe.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
-
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.
-
Version ARNs have only the first three nodes:
. . -
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
Sourcepub fn get_arn(&self) -> &Option<String>
pub fn get_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the container recipe.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
-
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.
-
Version ARNs have only the first three nodes:
. . -
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
Sourcepub fn container_type(self, input: ContainerType) -> Self
pub fn container_type(self, input: ContainerType) -> Self
Specifies the type of container, such as Docker.
Sourcepub fn set_container_type(self, input: Option<ContainerType>) -> Self
pub fn set_container_type(self, input: Option<ContainerType>) -> Self
Specifies the type of container, such as Docker.
Sourcepub fn get_container_type(&self) -> &Option<ContainerType>
pub fn get_container_type(&self) -> &Option<ContainerType>
Specifies the type of container, such as Docker.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the container recipe.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the container recipe.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the container recipe.
Sourcepub fn platform(self, input: Platform) -> Self
pub fn platform(self, input: Platform) -> Self
The system platform for the container, such as Windows or Linux.
Sourcepub fn set_platform(self, input: Option<Platform>) -> Self
pub fn set_platform(self, input: Option<Platform>) -> Self
The system platform for the container, such as Windows or Linux.
Sourcepub fn get_platform(&self) -> &Option<Platform>
pub fn get_platform(&self) -> &Option<Platform>
The system platform for the container, such as Windows or Linux.
Sourcepub fn version(self, input: impl Into<String>) -> Self
pub fn version(self, input: impl Into<String>) -> Self
The semantic version of the container recipe.
The semantic version has four nodes:
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-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.
Sourcepub fn set_version(self, input: Option<String>) -> Self
pub fn set_version(self, input: Option<String>) -> Self
The semantic version of the container recipe.
The semantic version has four nodes:
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-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.
Sourcepub fn get_version(&self) -> &Option<String>
pub fn get_version(&self) -> &Option<String>
The semantic version of the container recipe.
The semantic version has four nodes:
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-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.
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
.
Build and test components that are included in the container 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
Build and test components that are included in the container 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>>
Build and test components that are included in the container 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 instance_configuration(self, input: InstanceConfiguration) -> Self
pub fn instance_configuration(self, input: InstanceConfiguration) -> Self
A group of options that can be used to configure an instance for building and testing container images.
Sourcepub fn set_instance_configuration(
self,
input: Option<InstanceConfiguration>,
) -> Self
pub fn set_instance_configuration( self, input: Option<InstanceConfiguration>, ) -> Self
A group of options that can be used to configure an instance for building and testing container images.
Sourcepub fn get_instance_configuration(&self) -> &Option<InstanceConfiguration>
pub fn get_instance_configuration(&self) -> &Option<InstanceConfiguration>
A group of options that can be used to configure an instance for building and testing container images.
Sourcepub fn dockerfile_template_data(self, input: impl Into<String>) -> Self
pub fn dockerfile_template_data(self, input: impl Into<String>) -> Self
Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
Sourcepub fn set_dockerfile_template_data(self, input: Option<String>) -> Self
pub fn set_dockerfile_template_data(self, input: Option<String>) -> Self
Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
Sourcepub fn get_dockerfile_template_data(&self) -> &Option<String>
pub fn get_dockerfile_template_data(&self) -> &Option<String>
Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
Sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
Sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
Sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
Sourcepub fn encrypted(self, input: bool) -> Self
pub fn encrypted(self, input: bool) -> Self
A flag that indicates if the target container is encrypted.
Sourcepub fn set_encrypted(self, input: Option<bool>) -> Self
pub fn set_encrypted(self, input: Option<bool>) -> Self
A flag that indicates if the target container is encrypted.
Sourcepub fn get_encrypted(&self) -> &Option<bool>
pub fn get_encrypted(&self) -> &Option<bool>
A flag that indicates if the target container is encrypted.
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 container recipe. This can contain an Image Builder image resource ARN or a container image URI, for example amazonlinux:latest
.
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 container recipe. This can contain an Image Builder image resource ARN or a container image URI, for example amazonlinux:latest
.
Sourcepub fn get_parent_image(&self) -> &Option<String>
pub fn get_parent_image(&self) -> &Option<String>
The base image for customizations specified in the container recipe. This can contain an Image Builder image resource ARN or a container image URI, for example amazonlinux:latest
.
Sourcepub fn date_created(self, input: impl Into<String>) -> Self
pub fn date_created(self, input: impl Into<String>) -> Self
The date when this container 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 when this container recipe was created.
Sourcepub fn get_date_created(&self) -> &Option<String>
pub fn get_date_created(&self) -> &Option<String>
The date when this container recipe was created.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
Tags that are attached to the container recipe.
Tags that are attached to the container recipe.
Tags that are attached to the container recipe.
Sourcepub fn working_directory(self, input: impl Into<String>) -> Self
pub fn working_directory(self, input: impl Into<String>) -> Self
The working directory for use 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 for use during build and test workflows.
Sourcepub fn get_working_directory(&self) -> &Option<String>
pub fn get_working_directory(&self) -> &Option<String>
The working directory for use during build and test workflows.
Sourcepub fn target_repository(self, input: TargetContainerRepository) -> Self
pub fn target_repository(self, input: TargetContainerRepository) -> Self
The destination repository for the container image.
Sourcepub fn set_target_repository(
self,
input: Option<TargetContainerRepository>,
) -> Self
pub fn set_target_repository( self, input: Option<TargetContainerRepository>, ) -> Self
The destination repository for the container image.
Sourcepub fn get_target_repository(&self) -> &Option<TargetContainerRepository>
pub fn get_target_repository(&self) -> &Option<TargetContainerRepository>
The destination repository for the container image.
Sourcepub fn build(self) -> ContainerRecipe
pub fn build(self) -> ContainerRecipe
Consumes the builder and constructs a ContainerRecipe
.
Trait Implementations§
Source§impl Clone for ContainerRecipeBuilder
impl Clone for ContainerRecipeBuilder
Source§fn clone(&self) -> ContainerRecipeBuilder
fn clone(&self) -> ContainerRecipeBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ContainerRecipeBuilder
impl Debug for ContainerRecipeBuilder
Source§impl Default for ContainerRecipeBuilder
impl Default for ContainerRecipeBuilder
Source§fn default() -> ContainerRecipeBuilder
fn default() -> ContainerRecipeBuilder
Source§impl PartialEq for ContainerRecipeBuilder
impl PartialEq for ContainerRecipeBuilder
Source§fn eq(&self, other: &ContainerRecipeBuilder) -> bool
fn eq(&self, other: &ContainerRecipeBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ContainerRecipeBuilder
Auto Trait Implementations§
impl Freeze for ContainerRecipeBuilder
impl RefUnwindSafe for ContainerRecipeBuilder
impl Send for ContainerRecipeBuilder
impl Sync for ContainerRecipeBuilder
impl Unpin for ContainerRecipeBuilder
impl UnwindSafe for ContainerRecipeBuilder
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);