Struct aws_sdk_imagebuilder::types::builders::ImageBuilder

#[non_exhaustive]
pub struct ImageBuilder { /* private fields */ }

A builder for Image.

Implementations

impl ImageBuilder

pub fn arn(self, input: impl Into<String>) -> Self

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:

1. 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.

2. Version ARNs have only the first three nodes: . .

3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

pub fn set_arn(self, input: Option<String>) -> Self

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:

1. 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.

2. Version ARNs have only the first three nodes: . .

3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

pub fn type(self, input: ImageType) -> Self

Specifies whether this image produces an AMI or a container image.

pub fn set_type(self, input: Option<ImageType>) -> Self

Specifies whether this image produces an AMI or a container image.

pub fn name(self, input: impl Into<String>) -> Self

The name of the image.

pub fn set_name(self, input: Option<String>) -> Self

The name of the image.

pub fn version(self, input: impl Into<String>) -> Self

The semantic version of the image.

The semantic version has four nodes: . . / . You can assign values for the first three, and can filter on all of them.

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.

pub fn set_version(self, input: Option<String>) -> Self

The semantic version of the image.

The semantic version has four nodes: . . / . You can assign values for the first three, and can filter on all of them.

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.

pub fn platform(self, input: Platform) -> Self

The image operating system platform, such as Linux or Windows.

pub fn set_platform(self, input: Option<Platform>) -> Self

The image operating system platform, such as Linux or Windows.

pub fn enhanced_image_metadata_enabled(self, input: bool) -> Self

Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.

pub fn set_enhanced_image_metadata_enabled(self, input: Option<bool>) -> Self

Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.

pub fn os_version(self, input: impl Into<String>) -> Self

The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

pub fn set_os_version(self, input: Option<String>) -> Self

The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

pub fn state(self, input: ImageState) -> Self

The state of the image.

pub fn set_state(self, input: Option<ImageState>) -> Self

The state of the image.

pub fn image_recipe(self, input: ImageRecipe) -> Self

For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.

pub fn set_image_recipe(self, input: Option<ImageRecipe>) -> Self

For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.

pub fn container_recipe(self, input: ContainerRecipe) -> Self

For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.

pub fn set_container_recipe(self, input: Option<ContainerRecipe>) -> Self

For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.

pub fn source_pipeline_name(self, input: impl Into<String>) -> Self

The name of the image pipeline that created this image.

pub fn set_source_pipeline_name(self, input: Option<String>) -> Self

The name of the image pipeline that created this image.

pub fn source_pipeline_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the image pipeline that created this image.

pub fn set_source_pipeline_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the image pipeline that created this image.

pub fn infrastructure_configuration( self, input: InfrastructureConfiguration ) -> Self

The infrastructure that Image Builder used to create this image.

pub fn set_infrastructure_configuration( self, input: Option<InfrastructureConfiguration> ) -> Self

The infrastructure that Image Builder used to create this image.

pub fn distribution_configuration( self, input: DistributionConfiguration ) -> Self

The distribution configuration that Image Builder used to create this image.

pub fn set_distribution_configuration( self, input: Option<DistributionConfiguration> ) -> Self

The distribution configuration that Image Builder used to create this image.

pub fn image_tests_configuration(self, input: ImageTestsConfiguration) -> Self

The image tests that ran when that Image Builder created this image.

pub fn set_image_tests_configuration( self, input: Option<ImageTestsConfiguration> ) -> Self

The image tests that ran when that Image Builder created this image.

pub fn date_created(self, input: impl Into<String>) -> Self

The date on which Image Builder created this image.

pub fn set_date_created(self, input: Option<String>) -> Self

The date on which Image Builder created this image.

pub fn output_resources(self, input: OutputResources) -> Self

The output resources that Image Builder produces for this image.

pub fn set_output_resources(self, input: Option<OutputResources>) -> Self

The output resources that Image Builder produces for this image.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

The tags that apply to this image.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

The tags that apply to this image.

pub fn build_type(self, input: BuildType) -> Self

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.

pub fn set_build_type(self, input: Option<BuildType>) -> Self

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.

pub fn image_source(self, input: ImageSource) -> Self

The origin of the base image that Image Builder used to build this image.

pub fn set_image_source(self, input: Option<ImageSource>) -> Self

The origin of the base image that Image Builder used to build this image.

pub fn build(self) -> Image

Consumes the builder and constructs a Image.

Trait Implementations

impl Clone for ImageBuilder

fn clone(&self) -> ImageBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageBuilder

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

Formats the value using the given formatter.

impl Default for ImageBuilder

fn default() -> ImageBuilder

Returns the “default value” for a type.

impl PartialEq<ImageBuilder> for ImageBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ImageBuilder