Class: Aws::Imagebuilder::Types::Workflow

Inherits:

Struct

• Object
• Struct
• Aws::Imagebuilder::Types::Workflow

Includes:

Structure

Defined in:

lib/aws-sdk-imagebuilder/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

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

• #change_description ⇒ 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 ⇒ String

  Contains the YAML document content for the workflow.

• #date_created ⇒ String

  The timestamp when Image Builder created the workflow resource.

• #description ⇒ String

  The description of the workflow.

• #kms_key_id ⇒ String

  The KMS key identifier used to encrypt the workflow resource.

• #name ⇒ String

  The name of the workflow resource.

• #owner ⇒ String

  The owner of the workflow resource.

• #parameters ⇒ Array<Types::WorkflowParameterDetail>

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

• #state ⇒ Types::WorkflowState

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

• #tags ⇒ Hash<String,String>

  The tags that apply to the workflow resource.

• #type ⇒ String

  Specifies the image creation stage that the workflow applies to.

• #version ⇒ String

  The workflow resource version.

Instance Attribute Details

#arn ⇒ String

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

Returns:

# File 'lib/aws-sdk-imagebuilder/types.rb', line 8912

class Workflow < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :state,
  :owner,
  :data,
  :kms_key_id,
  :date_created,
  :tags,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#change_description ⇒ 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.

Returns:

# File 'lib/aws-sdk-imagebuilder/types.rb', line 8912

class Workflow < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :state,
  :owner,
  :data,
  :kms_key_id,
  :date_created,
  :tags,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#data ⇒ String

Contains the YAML document content for the workflow.

Returns:

# File 'lib/aws-sdk-imagebuilder/types.rb', line 8912

class Workflow < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :state,
  :owner,
  :data,
  :kms_key_id,
  :date_created,
  :tags,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#date_created ⇒ String

The timestamp when Image Builder created the workflow resource.

Returns:

# File 'lib/aws-sdk-imagebuilder/types.rb', line 8912

class Workflow < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :state,
  :owner,
  :data,
  :kms_key_id,
  :date_created,
  :tags,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the workflow.

Returns:

# File 'lib/aws-sdk-imagebuilder/types.rb', line 8912

class Workflow < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :state,
  :owner,
  :data,
  :kms_key_id,
  :date_created,
  :tags,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The KMS key identifier used to encrypt the workflow resource. This can be either the Key ARN or the Alias ARN. For more information, see [Key identifiers (KeyId)] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN

Returns:

# File 'lib/aws-sdk-imagebuilder/types.rb', line 8912

class Workflow < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :state,
  :owner,
  :data,
  :kms_key_id,
  :date_created,
  :tags,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the workflow resource.

Returns:

# File 'lib/aws-sdk-imagebuilder/types.rb', line 8912

class Workflow < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :state,
  :owner,
  :data,
  :kms_key_id,
  :date_created,
  :tags,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#owner ⇒ String

The owner of the workflow resource.

Returns:

# File 'lib/aws-sdk-imagebuilder/types.rb', line 8912

class Workflow < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :state,
  :owner,
  :data,
  :kms_key_id,
  :date_created,
  :tags,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Array<Types::WorkflowParameterDetail>

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

Returns:

# File 'lib/aws-sdk-imagebuilder/types.rb', line 8912

class Workflow < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :state,
  :owner,
  :data,
  :kms_key_id,
  :date_created,
  :tags,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ Types::WorkflowState

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

Returns:

# File 'lib/aws-sdk-imagebuilder/types.rb', line 8912

class Workflow < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :state,
  :owner,
  :data,
  :kms_key_id,
  :date_created,
  :tags,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags that apply to the workflow resource

Returns:

# File 'lib/aws-sdk-imagebuilder/types.rb', line 8912

class Workflow < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :state,
  :owner,
  :data,
  :kms_key_id,
  :date_created,
  :tags,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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

Returns:

# File 'lib/aws-sdk-imagebuilder/types.rb', line 8912

class Workflow < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :state,
  :owner,
  :data,
  :kms_key_id,
  :date_created,
  :tags,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

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

Returns:

# File 'lib/aws-sdk-imagebuilder/types.rb', line 8912

class Workflow < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :state,
  :owner,
  :data,
  :kms_key_id,
  :date_created,
  :tags,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end