Struct aws_sdk_imagebuilder::types::Component

#[non_exhaustive]
pub struct Component {

    pub arn: Option<String>,
    pub name: Option<String>,
    pub version: Option<String>,
    pub description: Option<String>,
    pub change_description: Option<String>,
    pub type: Option<ComponentType>,
    pub platform: Option<Platform>,
    pub supported_os_versions: Option<Vec<String>>,
    pub state: Option<ComponentState>,
    pub parameters: Option<Vec<ComponentParameterDetail>>,
    pub owner: Option<String>,
    pub data: Option<String>,
    pub kms_key_id: Option<String>,
    pub encrypted: Option<bool>,
    pub date_created: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub publisher: Option<String>,
    pub obfuscate: bool,
}

A detailed view of a component.

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.

arn: Option<String>

The Amazon Resource Name (ARN) of the component.

name: Option<String>

The name of the component.

version: Option<String>

The version of the component.

description: Option<String>

The description of the component.

change_description: Option<String>

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

type: Option<ComponentType>

The component type specifies whether Image Builder uses the component to build the image or only to test it.

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, Image Builder performs a prefix match against the base image OS version during image recipe creation.

state: Option<ComponentState>

Describes the current status of the component. This is used for components that are no longer active.

parameters: Option<Vec<ComponentParameterDetail>>

Contains parameter details for each of the parameters that the component document defined for the component.

owner: Option<String>

The owner of the component.

data: Option<String>

Component data contains the YAML document content for the component.

kms_key_id: Option<String>

The KMS key identifier used to encrypt the component.

encrypted: Option<bool>

The encryption status of the component.

date_created: Option<String>

The date that Image Builder created the component.

tags: Option<HashMap<String, String>>

The tags that apply to the component.

publisher: Option<String>

Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.

obfuscate: bool

Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.

Implementations

impl Component

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

The Amazon Resource Name (ARN) of the component.

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

The name of the component.

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

The version of the component.

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

The description of the component.

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

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

pub fn type(&self) -> Option<&ComponentType>

The component type specifies whether Image Builder uses the component to build the image or only to test it.

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, Image Builder performs a prefix match 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 state(&self) -> Option<&ComponentState>

Describes the current status of the component. This is used for components that are no longer active.

pub fn parameters(&self) -> &[ComponentParameterDetail]

Contains parameter details for each of the parameters that the component document defined for the component.

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

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

The owner of the component.

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

Component data contains the YAML document content for the component.

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

The KMS key identifier used to encrypt the component.

pub fn encrypted(&self) -> Option<bool>

The encryption status of the component.

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

The date that Image Builder created the component.

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

The tags that apply to the component.

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

Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.

pub fn obfuscate(&self) -> bool

Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.

impl Component

pub fn builder() -> ComponentBuilder

Creates a new builder-style object to manufacture Component.

Trait Implementations

impl Clone for Component

fn clone(&self) -> Component

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Component

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

Formats the value using the given formatter.

impl PartialEq for Component

fn eq(&self, other: &Component) -> 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 Component