Struct aws_sdk_appstream::types::Image
source · #[non_exhaustive]pub struct Image {Show 17 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>>,
}
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.
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()
.