Struct Workflow

#[non_exhaustive]
pub struct Workflow {

    pub arn: Option<String>,
    pub name: Option<String>,
    pub version: Option<String>,
    pub description: Option<String>,
    pub change_description: Option<String>,
    pub type: Option<WorkflowType>,
    pub state: Option<WorkflowState>,
    pub owner: Option<String>,
    pub data: Option<String>,
    pub kms_key_id: Option<String>,
    pub date_created: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub parameters: Option<Vec<WorkflowParameterDetail>>,
}

Defines a process that Image Builder uses to build and test images during the image creation process.

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 workflow resource.

name: Option<String>

The name of the workflow resource.

version: Option<String>

The workflow resource version. Workflow resources are immutable. To make a change, you can clone a workflow or create a new version.

description: Option<String>

The description of the workflow.

change_description: Option<String>

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

type: Option<WorkflowType>

Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows.

state: Option<WorkflowState>

Describes the current status of the workflow and the reason for that status.

owner: Option<String>

The owner of the workflow resource.

data: Option<String>

Contains the YAML document content for the workflow.

kms_key_id: Option<String>

The KMS key identifier used to encrypt the workflow resource.

date_created: Option<String>

The timestamp when Image Builder created the workflow resource.

tags: Option<HashMap<String, String>>

The tags that apply to the workflow resource

parameters: Option<Vec<WorkflowParameterDetail>>

An array of input parameters that that the image workflow uses to control actions or configure settings.

Implementations

impl Workflow

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

The Amazon Resource Name (ARN) of the workflow resource.

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

The name of the workflow resource.

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

The workflow resource version. Workflow resources are immutable. To make a change, you can clone a workflow or create a new version.

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

The description of the workflow.

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

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

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

Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows.

pub fn state(&self) -> Option<&WorkflowState>

Describes the current status of the workflow and the reason for that status.

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

The owner of the workflow resource.

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

Contains the YAML document content for the workflow.

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

The KMS key identifier used to encrypt the workflow resource.

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

The timestamp when Image Builder created the workflow resource.

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

The tags that apply to the workflow resource

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

An array of input parameters that that the image workflow uses to control actions or configure settings.

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().

impl Workflow

pub fn builder() -> WorkflowBuilder

Creates a new builder-style object to manufacture Workflow.

Trait Implementations

impl Clone for Workflow

fn clone(&self) -> Workflow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Workflow

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

Formats the value using the given formatter.

impl PartialEq for Workflow

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

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

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 Workflow