Class: Aws::Imagebuilder::Types::CreateWorkflowRequest

Inherits:

Struct

• Object
• Struct
• Aws::Imagebuilder::Types::CreateWorkflowRequest

Includes:

Structure

Defined in:

lib/aws-sdk-imagebuilder/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

• #client_token ⇒ String

  Unique, case-sensitive identifier you provide to ensure idempotency of the request.

• #data ⇒ String

  Contains the UTF-8 encoded YAML document content for the workflow.

• #description ⇒ String

  Describes the workflow.

• #dry_run ⇒ Boolean

  Validates the required permissions for the operation and the request parameters, without actually making the request, and provides an error response.

• #kms_key_id ⇒ String

  The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this workflow resource.

• #name ⇒ String

  The name of the workflow to create.

• #semantic_version ⇒ String

  The semantic version of this workflow resource.

• #tags ⇒ Hash<String,String>

  Tags that apply to the workflow resource.

• #type ⇒ String

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

• #uri ⇒ String

  The ‘uri` of a YAML component document file.

Instance Attribute Details

#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 2031

class CreateWorkflowRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :type,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ 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*.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

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

class CreateWorkflowRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :type,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

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

class CreateWorkflowRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :type,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Describes the workflow.

Returns:

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

class CreateWorkflowRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :type,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

Validates the required permissions for the operation and the request parameters, without actually making the request, and provides an error response. Upon a successful request, the error response is ‘DryRunOperationException`.

Returns:

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

class CreateWorkflowRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :type,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this 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 2031

class CreateWorkflowRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :type,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the workflow to create.

Returns:

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

class CreateWorkflowRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :type,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#semantic_version ⇒ String

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

<note markdown=“1”> The semantic version has four nodes: &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. 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.

</note>

Returns:

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

class CreateWorkflowRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :type,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags that apply to the workflow resource.

Returns:

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

class CreateWorkflowRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :type,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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

Returns:

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

class CreateWorkflowRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :type,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

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

class CreateWorkflowRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :type,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end