Struct Image

#[non_exhaustive]
pub struct Image {

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

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.

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.

image_shared_with_others: Option<ImageSharedWithOthers>

Indicates whether the image is shared with another account ID.

Implementations

impl Image

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

The name of the image.

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

The ARN of the image.

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

The ARN of the image from which this image was created.

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

The image name to display.

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.

pub fn visibility(&self) -> Option<&VisibilityType>

Indicates whether the image is public or private.

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

Indicates whether an image builder can be launched from this image.

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.

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

The operating system platform of the image.

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

The description to display.

pub fn state_change_reason(&self) -> Option<&ImageStateChangeReason>

The reason why the last state change occurred.

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

pub fn created_time(&self) -> Option<&DateTime>

The time the image was created.

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.

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.

pub fn image_permissions(&self) -> Option<&ImagePermissions>

The permissions to provide to the destination AWS account for the specified image.

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

pub fn latest_appstream_agent_version( &self, ) -> Option<&LatestAppstreamAgentVersion>

Indicates whether the image is using the latest AppStream 2.0 agent version or not.

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

pub fn dynamic_app_providers_enabled( &self, ) -> Option<&DynamicAppProvidersEnabled>

Indicates whether dynamic app providers are enabled within an AppStream 2.0 image or not.

pub fn image_shared_with_others(&self) -> Option<&ImageSharedWithOthers>

Indicates whether the image is shared with another account ID.

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