#[non_exhaustive]pub struct Image {Show 21 fields
pub name: Option<String>,
pub arn: Option<String>,
pub base_image_arn: Option<String>,
pub display_name: Option<String>,
pub state: Option<ImageState>,
pub visibility: Option<VisibilityType>,
pub image_builder_supported: Option<bool>,
pub image_builder_name: Option<String>,
pub platform: Option<PlatformType>,
pub description: Option<String>,
pub state_change_reason: Option<ImageStateChangeReason>,
pub applications: Option<Vec<Application>>,
pub created_time: Option<DateTime>,
pub public_base_image_released_date: Option<DateTime>,
pub appstream_agent_version: Option<String>,
pub image_permissions: Option<ImagePermissions>,
pub image_errors: Option<Vec<ResourceError>>,
pub latest_appstream_agent_version: Option<LatestAppstreamAgentVersion>,
pub supported_instance_families: Option<Vec<String>>,
pub dynamic_app_providers_enabled: Option<DynamicAppProvidersEnabled>,
pub image_shared_with_others: Option<ImageSharedWithOthers>,
}
Expand description
Describes an image.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.name: Option<String>
The name of the image.
arn: Option<String>
The ARN of the image.
base_image_arn: Option<String>
The ARN of the image from which this image was created.
display_name: Option<String>
The image name to display.
state: Option<ImageState>
The image starts in the PENDING
state. If image creation succeeds, the state is AVAILABLE
. If image creation fails, the state is FAILED
.
visibility: Option<VisibilityType>
Indicates whether the image is public or private.
image_builder_supported: Option<bool>
Indicates whether an image builder can be launched from this image.
image_builder_name: Option<String>
The name of the image builder that was used to create the private image. If the image is shared, this value is null.
platform: Option<PlatformType>
The operating system platform of the image.
description: Option<String>
The description to display.
state_change_reason: Option<ImageStateChangeReason>
The reason why the last state change occurred.
applications: Option<Vec<Application>>
The applications associated with the image.
created_time: Option<DateTime>
The time the image was created.
public_base_image_released_date: Option<DateTime>
The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
appstream_agent_version: Option<String>
The version of the AppStream 2.0 agent to use for instances that are launched from this image.
image_permissions: Option<ImagePermissions>
The permissions to provide to the destination AWS account for the specified image.
image_errors: Option<Vec<ResourceError>>
Describes the errors that are returned when a new image can't be created.
latest_appstream_agent_version: Option<LatestAppstreamAgentVersion>
Indicates whether the image is using the latest AppStream 2.0 agent version or not.
supported_instance_families: Option<Vec<String>>
The supported instances families that determine which image a customer can use when the customer launches a fleet or image builder. The following instances families are supported:
-
General Purpose
-
Compute Optimized
-
Memory Optimized
-
Graphics
-
Graphics Design
-
Graphics Pro
-
Graphics G4
-
Graphics G5
dynamic_app_providers_enabled: Option<DynamicAppProvidersEnabled>
Indicates whether dynamic app providers are enabled within an AppStream 2.0 image or not.
Indicates whether the image is shared with another account ID.
Implementations§
Source§impl Image
impl Image
Sourcepub fn base_image_arn(&self) -> Option<&str>
pub fn base_image_arn(&self) -> Option<&str>
The ARN of the image from which this image was created.
Sourcepub fn display_name(&self) -> Option<&str>
pub fn display_name(&self) -> Option<&str>
The image name to display.
Sourcepub fn state(&self) -> Option<&ImageState>
pub fn state(&self) -> Option<&ImageState>
The image starts in the PENDING
state. If image creation succeeds, the state is AVAILABLE
. If image creation fails, the state is FAILED
.
Sourcepub fn visibility(&self) -> Option<&VisibilityType>
pub fn visibility(&self) -> Option<&VisibilityType>
Indicates whether the image is public or private.
Sourcepub fn image_builder_supported(&self) -> Option<bool>
pub fn image_builder_supported(&self) -> Option<bool>
Indicates whether an image builder can be launched from this image.
Sourcepub fn image_builder_name(&self) -> Option<&str>
pub fn image_builder_name(&self) -> Option<&str>
The name of the image builder that was used to create the private image. If the image is shared, this value is null.
Sourcepub fn platform(&self) -> Option<&PlatformType>
pub fn platform(&self) -> Option<&PlatformType>
The operating system platform of the image.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description to display.
Sourcepub fn state_change_reason(&self) -> Option<&ImageStateChangeReason>
pub fn state_change_reason(&self) -> Option<&ImageStateChangeReason>
The reason why the last state change occurred.
Sourcepub fn applications(&self) -> &[Application]
pub fn applications(&self) -> &[Application]
The applications associated with the image.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .applications.is_none()
.
Sourcepub fn created_time(&self) -> Option<&DateTime>
pub fn created_time(&self) -> Option<&DateTime>
The time the image was created.
Sourcepub fn public_base_image_released_date(&self) -> Option<&DateTime>
pub fn public_base_image_released_date(&self) -> Option<&DateTime>
The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
Sourcepub fn appstream_agent_version(&self) -> Option<&str>
pub fn appstream_agent_version(&self) -> Option<&str>
The version of the AppStream 2.0 agent to use for instances that are launched from this image.
Sourcepub fn image_permissions(&self) -> Option<&ImagePermissions>
pub fn image_permissions(&self) -> Option<&ImagePermissions>
The permissions to provide to the destination AWS account for the specified image.
Sourcepub fn image_errors(&self) -> &[ResourceError]
pub fn image_errors(&self) -> &[ResourceError]
Describes the errors that are returned when a new image can't be created.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .image_errors.is_none()
.
Sourcepub fn latest_appstream_agent_version(
&self,
) -> Option<&LatestAppstreamAgentVersion>
pub fn latest_appstream_agent_version( &self, ) -> Option<&LatestAppstreamAgentVersion>
Indicates whether the image is using the latest AppStream 2.0 agent version or not.
Sourcepub fn supported_instance_families(&self) -> &[String]
pub fn supported_instance_families(&self) -> &[String]
The supported instances families that determine which image a customer can use when the customer launches a fleet or image builder. The following instances families are supported:
-
General Purpose
-
Compute Optimized
-
Memory Optimized
-
Graphics
-
Graphics Design
-
Graphics Pro
-
Graphics G4
-
Graphics G5
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .supported_instance_families.is_none()
.
Sourcepub fn dynamic_app_providers_enabled(
&self,
) -> Option<&DynamicAppProvidersEnabled>
pub fn dynamic_app_providers_enabled( &self, ) -> Option<&DynamicAppProvidersEnabled>
Indicates whether dynamic app providers are enabled within an AppStream 2.0 image or not.
Indicates whether the image is shared with another account ID.
Trait Implementations§
impl StructuralPartialEq for Image
Auto Trait Implementations§
impl Freeze for Image
impl RefUnwindSafe for Image
impl Send for Image
impl Sync for Image
impl Unpin for Image
impl UnwindSafe for Image
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);