Struct aws_sdk_imagebuilder::client::fluent_builders::CreateImageRecipe

pub struct CreateImageRecipe { /* private fields */ }

Fluent builder constructing a request to CreateImageRecipe.

Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.

Implementations

impl CreateImageRecipe

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateImageRecipe, AwsResponseRetryClassifier>, SdkError<CreateImageRecipeError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateImageRecipeOutput, SdkError<CreateImageRecipeError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

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

The name of the image recipe.

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

The name of the image recipe.

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

The description of the image recipe.

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

The description of the image recipe.

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

The semantic version of the image recipe. This version follows the semantic version syntax.

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.

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

The semantic version of the image recipe. This version follows the semantic version syntax.

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.

pub fn components(self, input: ComponentConfiguration) -> Self

Appends an item to components.

To override the contents of this collection use set_components.

The components of the image recipe.

pub fn set_components(self, input: Option<Vec<ComponentConfiguration>>) -> Self

The components of the image recipe.

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

The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

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

The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

pub fn block_device_mappings(self, input: InstanceBlockDeviceMapping) -> Self

Appends an item to blockDeviceMappings.

To override the contents of this collection use set_block_device_mappings.

The block device mappings of the image recipe.

pub fn set_block_device_mappings(
    self,
    input: Option<Vec<InstanceBlockDeviceMapping>>
) -> Self

The block device mappings of the image recipe.

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 of the image recipe.

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

The tags of the image recipe.

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

The working directory used during build and test workflows.

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

The working directory used during build and test workflows.

pub fn additional_instance_configuration(
    self,
    input: AdditionalInstanceConfiguration
) -> Self

Specify additional settings and launch scripts for your build instances.

pub fn set_additional_instance_configuration(
    self,
    input: Option<AdditionalInstanceConfiguration>
) -> Self

Specify additional settings and launch scripts for your build instances.

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

The idempotency token used to make this request idempotent.

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

The idempotency token used to make this request idempotent.

Trait Implementations

impl Clone for CreateImageRecipe

fn clone(&self) -> CreateImageRecipe

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateImageRecipe

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

Formats the value using the given formatter.