Struct Image

#[non_exhaustive]
pub struct Image {

    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>,
}

Describes an image.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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.

tags: Option<Vec<Tag>>

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

impl Image

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.

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.

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().

pub fn description(&self) -> Option<&str>

The description of the AMI that was provided during image creation.

pub fn ena_support(&self) -> Option<bool>

Specifies whether enhanced networking with ENA is enabled.

pub fn hypervisor(&self) -> Option<&HypervisorType>

The hypervisor type of the image. Only xen is supported. ovm is not supported.

pub fn image_owner_alias(&self) -> Option<&str>

The owner alias (amazon | aws-backup-vault | aws-marketplace).

pub fn name(&self) -> Option<&str>

The name of the AMI that was provided during image creation.

pub fn root_device_name(&self) -> Option<&str>

The device name of the root device volume (for example, /dev/sda1).

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.

pub fn sriov_net_support(&self) -> Option<&str>

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

pub fn state_reason(&self) -> Option<&StateReason>

The reason for the state change.

pub fn tags(&self) -> &[Tag]

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().

pub fn virtualization_type(&self) -> Option<&VirtualizationType>

The type of virtualization of the AMI.

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.

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.

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.

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.

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.

pub fn deregistration_protection(&self) -> Option<&str>

Indicates whether deregistration protection is enabled for the AMI.

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.

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.

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.

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.

pub fn image_id(&self) -> Option<&str>

The ID of the AMI.

pub fn image_location(&self) -> Option<&str>

The location of the AMI.

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.

pub fn owner_id(&self) -> Option<&str>

The ID of the Amazon Web Services account that owns the image.

pub fn creation_date(&self) -> Option<&str>

The date and time the image was created.

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.

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().

pub fn architecture(&self) -> Option<&ArchitectureValues>

The architecture of the image.

pub fn image_type(&self) -> Option<&ImageTypeValues>

The type of image.

pub fn kernel_id(&self) -> Option<&str>

The kernel associated with the image, if any. Only applicable for machine images.

pub fn ramdisk_id(&self) -> Option<&str>

The RAM disk associated with the image, if any. Only applicable for machine images.

pub fn platform(&self) -> Option<&PlatformValues>

This value is set to windows for Windows AMIs; otherwise, it is blank.

impl Image

pub fn builder() -> ImageBuilder

Creates a new builder-style object to manufacture Image.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Image

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Image

fn eq(&self, other: &Image) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Image