Struct CreateComponentInput

#[non_exhaustive]
pub struct CreateComponentInput {
    pub name: Option<String>,
    pub semantic_version: Option<String>,
    pub description: Option<String>,
    pub change_description: Option<String>,
    pub platform: Option<Platform>,
    pub supported_os_versions: Option<Vec<String>>,
    pub data: Option<String>,
    pub uri: Option<String>,
    pub kms_key_id: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub client_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the component.

semantic_version: Option<String>

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.

description: Option<String>

Describes the contents of the component.

change_description: Option<String>

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

platform: Option<Platform>

The operating system platform of the component.

supported_os_versions: Option<Vec<String>>

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.

data: Option<String>

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.

uri: Option<String>

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.

kms_key_id: Option<String>

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

tags: Option<HashMap<String, String>>

The tags that apply to the component.

client_token: Option<String>

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Implementations

impl CreateComponentInput

pub fn name(&self) -> Option<&str>

The name of the component.

pub fn semantic_version(&self) -> Option<&str>

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) -> Option<&str>

Describes the contents of the component.

pub fn change_description(&self) -> Option<&str>

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

pub fn platform(&self) -> Option<&Platform>

The operating system platform of the component.

pub fn supported_os_versions(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .supported_os_versions.is_none().

pub fn data(&self) -> Option<&str>

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) -> Option<&str>

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) -> Option<&str>

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

pub fn tags(&self) -> Option<&HashMap<String, String>>

The tags that apply to the component.

pub fn client_token(&self) -> Option<&str>

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

impl CreateComponentInput

pub fn builder() -> CreateComponentInputBuilder

Creates a new builder-style object to manufacture CreateComponentInput.

Trait Implementations

impl Clone for CreateComponentInput

fn clone(&self) -> CreateComponentInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateComponentInput

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

Formats the value using the given formatter.

impl PartialEq for CreateComponentInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CreateComponentInput