NodeLifecycleScript
A script to run during a compute node lifecycle stage.
Contents
- name
-
A unique name for the script. The name can be up to 64 characters long. Valid characters are letters, numbers, spaces, underscores (
_), and hyphens (-). The first character must be a letter or a number.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[A-Za-z0-9][A-Za-z0-9 _-]*Required: Yes
- scriptSource
-
The source location and integrity information for the script.
Type: ScriptSource object
Required: Yes
- arguments
-
The command-line arguments to pass to the script. You can specify up to 20 arguments, and each argument can be up to 256 characters long.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- executionPolicy
-
The policy that determines when the script runs. The default value is
FIRST_BOOT_ONLY. Valid values:-
FIRST_BOOT_ONLY– Runs the script only the first time the compute node boots. -
EVERY_BOOT– Runs the script every time the compute node boots, including reboots.
Type: String
Valid Values:
FIRST_BOOT_ONLY | EVERY_BOOTRequired: No
-
- onError
-
The behavior when the script fails. The default value is
TERMINATE. Valid values:-
TERMINATE– Terminates the compute node. -
STOP_SEQUENCE– Stops running subsequent scripts in the sequence but doesn't terminate the compute node. -
CONTINUE– Ignores the error and continues running the next script.
Type: String
Valid Values:
TERMINATE | STOP_SEQUENCE | CONTINUERequired: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: