Struct aws_sdk_imagebuilder::client::fluent_builders::CreateComponent

pub struct CreateComponent { /* private fields */ }

Fluent builder constructing a request to CreateComponent.

Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods:

• Inline, using the data property in the request body.

• A URL that points to a YAML document file stored in Amazon S3, using the uri property in the request body.

Implementations

impl CreateComponent

pub async fn send(
    self
) -> Result<CreateComponentOutput, SdkError<CreateComponentError>>

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

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

The name of the component.

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

The semantic version of the component. 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 component. 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 description(self, input: impl Into<String>) -> Self

The description of the component. Describes the contents of the component.

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

The description of the component. Describes the contents of the component.

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

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

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

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

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

The platform of the component.

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

The platform of the component.

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

Appends an item to supportedOsVersions.

To override the contents of this collection use set_supported_os_versions.

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

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

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

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

Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

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

Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

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

The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

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

The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

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

The ID of the KMS key that should be used to encrypt this component.

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

The ID of the KMS key that should be used to encrypt this component.

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

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

The tags of the component.

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

The idempotency token of the component.

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

The idempotency token of the component.

Trait Implementations

impl Clone for CreateComponent

fn clone(&self) -> CreateComponent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateComponent

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

Formats the value using the given formatter.