Struct aws_sdk_imagebuilder::model::Image
source · [−]#[non_exhaustive]pub struct Image {Show 19 fields
pub arn: Option<String>,
pub type: Option<ImageType>,
pub name: Option<String>,
pub version: Option<String>,
pub platform: Option<Platform>,
pub enhanced_image_metadata_enabled: Option<bool>,
pub os_version: Option<String>,
pub state: Option<ImageState>,
pub image_recipe: Option<ImageRecipe>,
pub container_recipe: Option<ContainerRecipe>,
pub source_pipeline_name: Option<String>,
pub source_pipeline_arn: Option<String>,
pub infrastructure_configuration: Option<InfrastructureConfiguration>,
pub distribution_configuration: Option<DistributionConfiguration>,
pub image_tests_configuration: Option<ImageTestsConfiguration>,
pub date_created: Option<String>,
pub output_resources: Option<OutputResources>,
pub tags: Option<HashMap<String, String>>,
pub build_type: Option<BuildType>,
}
Expand description
An Image Builder image. You must specify exactly one recipe for the image – either a container recipe (containerRecipe
), which creates a container image, or an image recipe (imageRecipe
), which creates an AMI.
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.arn: Option<String>
The Amazon Resource Name (ARN) of the image.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
-
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
-
Version ARNs have only the first three nodes:
. . -
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
type: Option<ImageType>
Specifies whether this is an AMI or container image.
name: Option<String>
The name of the image.
version: Option<String>
The semantic version of the image.
The semantic version has four nodes:
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
platform: Option<Platform>
The platform of the image.
enhanced_image_metadata_enabled: Option<bool>
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
os_version: Option<String>
The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
state: Option<ImageState>
The state of the image.
image_recipe: Option<ImageRecipe>
The image recipe used when creating the image.
container_recipe: Option<ContainerRecipe>
The recipe that is used to create an Image Builder container image.
source_pipeline_name: Option<String>
The name of the image pipeline that created this image.
source_pipeline_arn: Option<String>
The Amazon Resource Name (ARN) of the image pipeline that created this image.
infrastructure_configuration: Option<InfrastructureConfiguration>
The infrastructure used when creating this image.
distribution_configuration: Option<DistributionConfiguration>
The distribution configuration used when creating this image.
image_tests_configuration: Option<ImageTestsConfiguration>
The image tests configuration used when creating this image.
date_created: Option<String>
The date on which this image was created.
output_resources: Option<OutputResources>
The output resources produced when creating this image.
The tags of the image.
build_type: Option<BuildType>
Indicates the type of build that created this image. The build can be initiated in the following ways:
-
USER_INITIATED – A manual pipeline build request.
-
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
-
IMPORT – A VM import created the image to use as the base image for the recipe.
Implementations
sourceimpl Image
impl Image
sourcepub fn arn(&self) -> Option<&str>
pub fn arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the image.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
-
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
-
Version ARNs have only the first three nodes:
. . -
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
sourcepub fn version(&self) -> Option<&str>
pub fn version(&self) -> Option<&str>
The semantic version of the image.
The semantic version has four nodes:
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
sourcepub fn enhanced_image_metadata_enabled(&self) -> Option<bool>
pub fn enhanced_image_metadata_enabled(&self) -> Option<bool>
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
sourcepub fn os_version(&self) -> Option<&str>
pub fn os_version(&self) -> Option<&str>
The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
sourcepub fn state(&self) -> Option<&ImageState>
pub fn state(&self) -> Option<&ImageState>
The state of the image.
sourcepub fn image_recipe(&self) -> Option<&ImageRecipe>
pub fn image_recipe(&self) -> Option<&ImageRecipe>
The image recipe used when creating the image.
sourcepub fn container_recipe(&self) -> Option<&ContainerRecipe>
pub fn container_recipe(&self) -> Option<&ContainerRecipe>
The recipe that is used to create an Image Builder container image.
sourcepub fn source_pipeline_name(&self) -> Option<&str>
pub fn source_pipeline_name(&self) -> Option<&str>
The name of the image pipeline that created this image.
sourcepub fn source_pipeline_arn(&self) -> Option<&str>
pub fn source_pipeline_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the image pipeline that created this image.
sourcepub fn infrastructure_configuration(
&self
) -> Option<&InfrastructureConfiguration>
pub fn infrastructure_configuration(
&self
) -> Option<&InfrastructureConfiguration>
The infrastructure used when creating this image.
sourcepub fn distribution_configuration(&self) -> Option<&DistributionConfiguration>
pub fn distribution_configuration(&self) -> Option<&DistributionConfiguration>
The distribution configuration used when creating this image.
sourcepub fn image_tests_configuration(&self) -> Option<&ImageTestsConfiguration>
pub fn image_tests_configuration(&self) -> Option<&ImageTestsConfiguration>
The image tests configuration used when creating this image.
sourcepub fn date_created(&self) -> Option<&str>
pub fn date_created(&self) -> Option<&str>
The date on which this image was created.
sourcepub fn output_resources(&self) -> Option<&OutputResources>
pub fn output_resources(&self) -> Option<&OutputResources>
The output resources produced when creating this image.
The tags of the image.
sourcepub fn build_type(&self) -> Option<&BuildType>
pub fn build_type(&self) -> Option<&BuildType>
Indicates the type of build that created this image. The build can be initiated in the following ways:
-
USER_INITIATED – A manual pipeline build request.
-
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
-
IMPORT – A VM import created the image to use as the base image for the recipe.
Trait Implementations
impl StructuralPartialEq for Image
Auto Trait Implementations
impl RefUnwindSafe for Image
impl Send for Image
impl Sync for Image
impl Unpin for Image
impl UnwindSafe for Image
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more