Skip to main content

Script Execute

Stable

Type: DEVRAMPS:SCRIPT:EXECUTE

Category: script

Version: 1.0.0


Description

Execute a custom script in the target AWS account.

Executes an arbitrary script from your repository in the target AWS account. The script runs in a secure environment with access to AWS credentials for the specified account. Useful for custom deployment logic, data migrations, or integration with external systems.

Parameters

Required Parameters

ParameterTypeDescription
script_pathstringPath to the script file relative to repository root.

Optional Parameters

ParameterTypeDefaultDescription
account_idstring-The AWS account ID to assume credentials for. Defaults to stage account.
regionstring-The AWS region. Defaults to stage region.
paramsarray<string>-Command-line arguments to pass to the script.
timeoutinteger30Script execution timeout in minutes.
working_directorystring-Working directory for script execution.
environment_variablesobject-Environment variables to set for the script.
run_in_vpcbooleanfalseWhether to run the script within a VPC for private resource access.

Example Usage

- type: DEVRAMPS:SCRIPT:EXECUTE
name: Run Migration Script
params:
script_path: ./scripts/migrate.sh
params:
- --environment
- production
working_directory: ./scripts
environment_variables:
DATABASE_URL: "${{ stage.secrets.DATABASE_URL }}"
timeout: 30