#[non_exhaustive]pub struct Image {Show 36 fields
pub platform_details: Option<String>,
pub usage_operation: Option<String>,
pub block_device_mappings: Option<Vec<BlockDeviceMapping>>,
pub description: Option<String>,
pub ena_support: Option<bool>,
pub hypervisor: Option<HypervisorType>,
pub image_owner_alias: Option<String>,
pub name: Option<String>,
pub root_device_name: Option<String>,
pub root_device_type: Option<DeviceType>,
pub sriov_net_support: Option<String>,
pub state_reason: Option<StateReason>,
pub tags: Option<Vec<Tag>>,
pub virtualization_type: Option<VirtualizationType>,
pub boot_mode: Option<BootModeValues>,
pub tpm_support: Option<TpmSupportValues>,
pub deprecation_time: Option<String>,
pub imds_support: Option<ImdsSupportValues>,
pub source_instance_id: Option<String>,
pub deregistration_protection: Option<String>,
pub last_launched_time: Option<String>,
pub image_allowed: Option<bool>,
pub source_image_id: Option<String>,
pub source_image_region: Option<String>,
pub image_id: Option<String>,
pub image_location: Option<String>,
pub state: Option<ImageState>,
pub owner_id: Option<String>,
pub creation_date: Option<String>,
pub public: Option<bool>,
pub product_codes: Option<Vec<ProductCode>>,
pub architecture: Option<ArchitectureValues>,
pub image_type: Option<ImageTypeValues>,
pub kernel_id: Option<String>,
pub ramdisk_id: Option<String>,
pub platform: Option<PlatformValues>,
}
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.platform_details: Option<String>
The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.
usage_operation: Option<String>
The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation
corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.
block_device_mappings: Option<Vec<BlockDeviceMapping>>
Any block device mapping entries.
description: Option<String>
The description of the AMI that was provided during image creation.
ena_support: Option<bool>
Specifies whether enhanced networking with ENA is enabled.
hypervisor: Option<HypervisorType>
The hypervisor type of the image. Only xen
is supported. ovm
is not supported.
image_owner_alias: Option<String>
The owner alias (amazon
| aws-backup-vault
| aws-marketplace
).
name: Option<String>
The name of the AMI that was provided during image creation.
root_device_name: Option<String>
The device name of the root device volume (for example, /dev/sda1
).
root_device_type: Option<DeviceType>
The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
sriov_net_support: Option<String>
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
state_reason: Option<StateReason>
The reason for the state change.
Any tags assigned to the image.
virtualization_type: Option<VirtualizationType>
The type of virtualization of the AMI.
boot_mode: Option<BootModeValues>
The boot mode of the image. For more information, see Instance launch behavior with Amazon EC2 boot modes in the Amazon EC2 User Guide.
tpm_support: Option<TpmSupportValues>
If the image is configured for NitroTPM support, the value is v2.0
. For more information, see NitroTPM in the Amazon EC2 User Guide.
deprecation_time: Option<String>
The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
imds_support: Option<ImdsSupportValues>
If v2.0
, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens
automatically set to required
so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit
is set to 2
. For more information, see Configure the AMI in the Amazon EC2 User Guide.
source_instance_id: Option<String>
The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.
deregistration_protection: Option<String>
Indicates whether deregistration protection is enabled for the AMI.
last_launched_time: Option<String>
The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.
lastLaunchedTime
data is available starting April 2017.
image_allowed: Option<bool>
If true
, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If false
and Allowed AMIs is set to enabled
, the AMI can't be discovered or used in the account. If false
and Allowed AMIs is set to audit-mode
, the AMI can be discovered and used in the account.
For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.
source_image_id: Option<String>
The ID of the source AMI from which the AMI was created.
The ID only appears if the AMI was created using CreateImage
, CopyImage
, or CreateRestoreImageTask
. The ID does not appear if the AMI was created using any other API. For some older AMIs, the ID might not be available. For more information, see Identify the source AMI used to create a new Amazon EC2 AMI in the Amazon EC2 User Guide.
source_image_region: Option<String>
The Region of the source AMI.
The Region only appears if the AMI was created using CreateImage
, CopyImage
, or CreateRestoreImageTask
. The Region does not appear if the AMI was created using any other API. For some older AMIs, the Region might not be available. For more information, see Identify the source AMI used to create a new Amazon EC2 AMI in the Amazon EC2 User Guide.
image_id: Option<String>
The ID of the AMI.
image_location: Option<String>
The location of the AMI.
state: Option<ImageState>
The current state of the AMI. If the state is available
, the image is successfully registered and can be used to launch an instance.
owner_id: Option<String>
The ID of the Amazon Web Services account that owns the image.
creation_date: Option<String>
The date and time the image was created.
public: Option<bool>
Indicates whether the image has public launch permissions. The value is true
if this image has public launch permissions or false
if it has only implicit and explicit launch permissions.
product_codes: Option<Vec<ProductCode>>
Any product codes associated with the AMI.
architecture: Option<ArchitectureValues>
The architecture of the image.
image_type: Option<ImageTypeValues>
The type of image.
kernel_id: Option<String>
The kernel associated with the image, if any. Only applicable for machine images.
ramdisk_id: Option<String>
The RAM disk associated with the image, if any. Only applicable for machine images.
platform: Option<PlatformValues>
This value is set to windows
for Windows AMIs; otherwise, it is blank.
Implementations§
Source§impl Image
impl Image
Sourcepub fn platform_details(&self) -> Option<&str>
pub fn platform_details(&self) -> Option<&str>
The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.
Sourcepub fn usage_operation(&self) -> Option<&str>
pub fn usage_operation(&self) -> Option<&str>
The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation
corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.
Sourcepub fn block_device_mappings(&self) -> &[BlockDeviceMapping]
pub fn block_device_mappings(&self) -> &[BlockDeviceMapping]
Any block device mapping entries.
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()
.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the AMI that was provided during image creation.
Sourcepub fn ena_support(&self) -> Option<bool>
pub fn ena_support(&self) -> Option<bool>
Specifies whether enhanced networking with ENA is enabled.
Sourcepub fn hypervisor(&self) -> Option<&HypervisorType>
pub fn hypervisor(&self) -> Option<&HypervisorType>
The hypervisor type of the image. Only xen
is supported. ovm
is not supported.
Sourcepub fn image_owner_alias(&self) -> Option<&str>
pub fn image_owner_alias(&self) -> Option<&str>
The owner alias (amazon
| aws-backup-vault
| aws-marketplace
).
Sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
The name of the AMI that was provided during image creation.
Sourcepub fn root_device_name(&self) -> Option<&str>
pub fn root_device_name(&self) -> Option<&str>
The device name of the root device volume (for example, /dev/sda1
).
Sourcepub fn root_device_type(&self) -> Option<&DeviceType>
pub fn root_device_type(&self) -> Option<&DeviceType>
The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
Sourcepub fn sriov_net_support(&self) -> Option<&str>
pub fn sriov_net_support(&self) -> Option<&str>
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
Sourcepub fn state_reason(&self) -> Option<&StateReason>
pub fn state_reason(&self) -> Option<&StateReason>
The reason for the state change.
Any tags assigned to 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 .tags.is_none()
.
Sourcepub fn virtualization_type(&self) -> Option<&VirtualizationType>
pub fn virtualization_type(&self) -> Option<&VirtualizationType>
The type of virtualization of the AMI.
Sourcepub fn boot_mode(&self) -> Option<&BootModeValues>
pub fn boot_mode(&self) -> Option<&BootModeValues>
The boot mode of the image. For more information, see Instance launch behavior with Amazon EC2 boot modes in the Amazon EC2 User Guide.
Sourcepub fn tpm_support(&self) -> Option<&TpmSupportValues>
pub fn tpm_support(&self) -> Option<&TpmSupportValues>
If the image is configured for NitroTPM support, the value is v2.0
. For more information, see NitroTPM in the Amazon EC2 User Guide.
Sourcepub fn deprecation_time(&self) -> Option<&str>
pub fn deprecation_time(&self) -> Option<&str>
The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
Sourcepub fn imds_support(&self) -> Option<&ImdsSupportValues>
pub fn imds_support(&self) -> Option<&ImdsSupportValues>
If v2.0
, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens
automatically set to required
so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit
is set to 2
. For more information, see Configure the AMI in the Amazon EC2 User Guide.
Sourcepub fn source_instance_id(&self) -> Option<&str>
pub fn source_instance_id(&self) -> Option<&str>
The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.
Sourcepub fn deregistration_protection(&self) -> Option<&str>
pub fn deregistration_protection(&self) -> Option<&str>
Indicates whether deregistration protection is enabled for the AMI.
Sourcepub fn last_launched_time(&self) -> Option<&str>
pub fn last_launched_time(&self) -> Option<&str>
The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.
lastLaunchedTime
data is available starting April 2017.
Sourcepub fn image_allowed(&self) -> Option<bool>
pub fn image_allowed(&self) -> Option<bool>
If true
, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If false
and Allowed AMIs is set to enabled
, the AMI can't be discovered or used in the account. If false
and Allowed AMIs is set to audit-mode
, the AMI can be discovered and used in the account.
For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.
Sourcepub fn source_image_id(&self) -> Option<&str>
pub fn source_image_id(&self) -> Option<&str>
The ID of the source AMI from which the AMI was created.
The ID only appears if the AMI was created using CreateImage
, CopyImage
, or CreateRestoreImageTask
. The ID does not appear if the AMI was created using any other API. For some older AMIs, the ID might not be available. For more information, see Identify the source AMI used to create a new Amazon EC2 AMI in the Amazon EC2 User Guide.
Sourcepub fn source_image_region(&self) -> Option<&str>
pub fn source_image_region(&self) -> Option<&str>
The Region of the source AMI.
The Region only appears if the AMI was created using CreateImage
, CopyImage
, or CreateRestoreImageTask
. The Region does not appear if the AMI was created using any other API. For some older AMIs, the Region might not be available. For more information, see Identify the source AMI used to create a new Amazon EC2 AMI in the Amazon EC2 User Guide.
Sourcepub fn image_location(&self) -> Option<&str>
pub fn image_location(&self) -> Option<&str>
The location of the AMI.
Sourcepub fn state(&self) -> Option<&ImageState>
pub fn state(&self) -> Option<&ImageState>
The current state of the AMI. If the state is available
, the image is successfully registered and can be used to launch an instance.
Sourcepub fn owner_id(&self) -> Option<&str>
pub fn owner_id(&self) -> Option<&str>
The ID of the Amazon Web Services account that owns the image.
Sourcepub fn creation_date(&self) -> Option<&str>
pub fn creation_date(&self) -> Option<&str>
The date and time the image was created.
Sourcepub fn public(&self) -> Option<bool>
pub fn public(&self) -> Option<bool>
Indicates whether the image has public launch permissions. The value is true
if this image has public launch permissions or false
if it has only implicit and explicit launch permissions.
Sourcepub fn product_codes(&self) -> &[ProductCode]
pub fn product_codes(&self) -> &[ProductCode]
Any product codes associated with the AMI.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .product_codes.is_none()
.
Sourcepub fn architecture(&self) -> Option<&ArchitectureValues>
pub fn architecture(&self) -> Option<&ArchitectureValues>
The architecture of the image.
Sourcepub fn image_type(&self) -> Option<&ImageTypeValues>
pub fn image_type(&self) -> Option<&ImageTypeValues>
The type of image.
Sourcepub fn kernel_id(&self) -> Option<&str>
pub fn kernel_id(&self) -> Option<&str>
The kernel associated with the image, if any. Only applicable for machine images.
Sourcepub fn ramdisk_id(&self) -> Option<&str>
pub fn ramdisk_id(&self) -> Option<&str>
The RAM disk associated with the image, if any. Only applicable for machine images.
Sourcepub fn platform(&self) -> Option<&PlatformValues>
pub fn platform(&self) -> Option<&PlatformValues>
This value is set to windows
for Windows AMIs; otherwise, it is blank.
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);