Struct CreateWorkflowInput

#[non_exhaustive]
pub struct CreateWorkflowInput {
    pub name: Option<String>,
    pub semantic_version: Option<String>,
    pub description: Option<String>,
    pub change_description: Option<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>,
    pub type: Option<WorkflowType>,
}

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 workflow to create.

semantic_version: Option<String>

The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.

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

data: Option<String>

Contains the UTF-8 encoded YAML document content for the workflow. 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 workflow resource.

tags: Option<HashMap<String, String>>

Tags that apply to the workflow resource.

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.

type: Option<WorkflowType>

The phase in the image build process for which the workflow resource is responsible.

Implementations

impl CreateWorkflowInput

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

The name of the workflow to create.

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

The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.

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

Contains the UTF-8 encoded YAML document content for the workflow. 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 workflow resource.

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

Tags that apply to the workflow resource.

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.

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

The phase in the image build process for which the workflow resource is responsible.

impl CreateWorkflowInput

pub fn builder() -> CreateWorkflowInputBuilder

Creates a new builder-style object to manufacture CreateWorkflowInput.

Trait Implementations

impl Clone for CreateWorkflowInput

fn clone(&self) -> CreateWorkflowInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateWorkflowInput

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

Formats the value using the given formatter.

impl PartialEq for CreateWorkflowInput

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