pub struct CreateComponentFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateComponent
.
Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods:
-
Inline, using the
data
property in the request body. -
A URL that points to a YAML document file stored in Amazon S3, using the
uri
property in the request body.
Implementations§
Source§impl CreateComponentFluentBuilder
impl CreateComponentFluentBuilder
Sourcepub fn as_input(&self) -> &CreateComponentInputBuilder
pub fn as_input(&self) -> &CreateComponentInputBuilder
Access the CreateComponent as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateComponentOutput, SdkError<CreateComponentError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateComponentOutput, SdkError<CreateComponentError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateComponentOutput, CreateComponentError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateComponentOutput, CreateComponentError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn semantic_version(self, input: impl Into<String>) -> Self
pub fn semantic_version(self, input: impl Into<String>) -> Self
The semantic version of the component. This version follows the semantic version syntax.
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.
Sourcepub fn set_semantic_version(self, input: Option<String>) -> Self
pub fn set_semantic_version(self, input: Option<String>) -> Self
The semantic version of the component. This version follows the semantic version syntax.
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.
Sourcepub fn get_semantic_version(&self) -> &Option<String>
pub fn get_semantic_version(&self) -> &Option<String>
The semantic version of the component. This version follows the semantic version syntax.
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.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
Describes the contents of the component.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
Describes the contents of the component.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
Describes the contents of the component.
Sourcepub fn change_description(self, input: impl Into<String>) -> Self
pub fn change_description(self, input: impl Into<String>) -> Self
The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.
Sourcepub fn set_change_description(self, input: Option<String>) -> Self
pub fn set_change_description(self, input: Option<String>) -> Self
The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.
Sourcepub fn get_change_description(&self) -> &Option<String>
pub fn get_change_description(&self) -> &Option<String>
The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.
Sourcepub fn set_platform(self, input: Option<Platform>) -> Self
pub fn set_platform(self, input: Option<Platform>) -> Self
The operating system platform of the component.
Sourcepub fn get_platform(&self) -> &Option<Platform>
pub fn get_platform(&self) -> &Option<Platform>
The operating system platform of the component.
Sourcepub fn supported_os_versions(self, input: impl Into<String>) -> Self
pub fn supported_os_versions(self, input: impl Into<String>) -> Self
Appends an item to supportedOsVersions
.
To override the contents of this collection use set_supported_os_versions
.
The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
Sourcepub fn set_supported_os_versions(self, input: Option<Vec<String>>) -> Self
pub fn set_supported_os_versions(self, input: Option<Vec<String>>) -> Self
The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
Sourcepub fn get_supported_os_versions(&self) -> &Option<Vec<String>>
pub fn get_supported_os_versions(&self) -> &Option<Vec<String>>
The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
Sourcepub fn data(self, input: impl Into<String>) -> Self
pub fn data(self, input: impl Into<String>) -> Self
Component data
contains inline YAML document content for the component. Alternatively, you can specify the uri
of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
Sourcepub fn set_data(self, input: Option<String>) -> Self
pub fn set_data(self, input: Option<String>) -> Self
Component data
contains inline YAML document content for the component. Alternatively, you can specify the uri
of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
Sourcepub fn get_data(&self) -> &Option<String>
pub fn get_data(&self) -> &Option<String>
Component data
contains inline YAML document content for the component. Alternatively, you can specify the uri
of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
Sourcepub fn uri(self, input: impl Into<String>) -> Self
pub fn uri(self, input: impl Into<String>) -> Self
The uri
of a YAML component document file. This must be an S3 URL (s3://bucket/key
), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data
property. You cannot specify both properties.
Sourcepub fn set_uri(self, input: Option<String>) -> Self
pub fn set_uri(self, input: Option<String>) -> Self
The uri
of a YAML component document file. This must be an S3 URL (s3://bucket/key
), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data
property. You cannot specify both properties.
Sourcepub fn get_uri(&self) -> &Option<String>
pub fn get_uri(&self) -> &Option<String>
The uri
of a YAML component document file. This must be an S3 URL (s3://bucket/key
), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data
property. You cannot specify both properties.
Sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
The ID of the KMS key that is used to encrypt this component.
Sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
The ID of the KMS key that is used to encrypt this component.
Sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
The ID of the KMS key that is used to encrypt this component.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
The tags that apply to the component.
The tags that apply to the component.
The tags that apply to the component.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
Trait Implementations§
Source§impl Clone for CreateComponentFluentBuilder
impl Clone for CreateComponentFluentBuilder
Source§fn clone(&self) -> CreateComponentFluentBuilder
fn clone(&self) -> CreateComponentFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateComponentFluentBuilder
impl !RefUnwindSafe for CreateComponentFluentBuilder
impl Send for CreateComponentFluentBuilder
impl Sync for CreateComponentFluentBuilder
impl Unpin for CreateComponentFluentBuilder
impl !UnwindSafe for CreateComponentFluentBuilder
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);