AWS CLI

Executes AWS CLI commands to manage AWS resources.

Object Representation (YAML)

id: String
name: String
type: String
depends: [String]
tags: [String]
condition: Boolean
each: Array
while: String
until: String
verbosity: String
ignore_errors: Boolean
tool_version: String
tool_options: Object
properties:
  credential: String
  profile: String
  region: String
  cwd: String
  args: String
  script_content: String
  script_path: String
  credentials_content: String
  credentials_path: String
  config_content: String
  config_path: String
  env:
    - name: String
      value: String

Fields

Property Details
id *

String

A unique identifier for the step.

Can contain hyphens and underscores, but not spaces.
name *

String

A friendly name for the step. This name will appear in the pipeline designer and run output.
type *

String

The type of the step. Can be pipeline or a step module type.
depends[]

[String]

A list of dependencies of this step.

This step will not be executed until all steps with ids in this list are finished executing.
tags[]

[String]

Tags are used to group related steps. Steps with the same tag can be retrieved using the findStepsByTag() helper function.

Can contain hyphens and underscores, but not spaces.
condition

Boolean

An expression which is evaluated before the step executes. If it evaluates to false, the step will be skipped. The step.result.status field will be "Skipped".
each

Array

An expression which evaluates to an array. It is evaluated once before the first iteration. There will be one iteration for each element of the array. An empty array ([]) will results in no iterations being executed.
while

String

A boolean expression evaluated before each iteration. When the expression evaluates to false, iteration stops. If false before the first iteration, no iterations will be executed.
until

String

A boolean expression evaluated after each iteration. When the expression evaluates to true, iteration stops. The first iteration will always be excuted with no regard for the value of the expression.
verbosity

String

Step event verbosity. Determines how much information about step execution is sent back to the application.
ignore_errors

Boolean

If true, errors in the step module will not halt pipeline execution, and subsequent steps will still be executed. The step.result.status field will be "Failed" if the step encounters an error.
tool_version

String

The version to use for tool installation.
tool_options

Object

-

properties.credential

String

The ID of an AWS IAM Access Key credential. See here for more information.
properties.profile

String

AWS named profile. Specifying this property literally set AWS_PROFILE environment variable.
properties.region

String

AWS region to send the request to. Specifying this property literally set AWS_DEFAULT_REGION environment variable.
properties.cwd

String

If provided, the script will use this path as its working directory.
properties.args

String

Arguments provided to the script, as a single string.
properties.script_content

String

Path to an existing script to execute. Provide one of script_content or script_path, but not both.
properties.script_path

String

Inline script content. Provide one of script_content or script_path, but not both.
properties.credentials_content

String

Path to an existing credentials configuration file. Provide one of credentials_content or credentials_path, but not both.
properties.credentials_path

String

Content of credentials configuration file. Provide one of credentials_content or credentials_path, but not both.
properties.config_content

String

Path to an existing config configuration file. Provide one of config_content or config_path, but not both.
properties.config_path

String

Content of configuration file. Provide one of config_content or config_path, but not both.
properties.env[]

[Object]

A list of environment variables that will be set for script execution.
properties.env[].name *

String

Environment variable name.
properties.env[].value *

String

Environment variable value.

Result Fields

The following are the step execution result fields available at steps.<step id>.result after a step executes.

Key Details
result.status

String

A string indicating the step execution status. Can be Succeeded, Failed, or Skipped.
result.exit_code

Number

Exit code of the script process.
result.stdout

String

Stdout of the script process.
result.stderr

String

Stderr of the script process.