aws-cdk-lib.aws_ec2.InitCommandOptions

InitCommandOptions Struct

Options for InitCommand.

Source

aws-ec2/lib/cfn-init-elements.ts

Example

const handle = new ec2.InitServiceRestartHandle();
ec2.CloudFormationInit.fromElements(
  ec2.InitCommand.shellCommand('/usr/bin/custom-nginx-install.sh', { serviceRestartHandles: [handle] }),
  ec2.InitService.enable('nginx', { serviceRestartHandle: handle }),
);

Properties

cwd?optionalstringcwd?optionalstrcwd?optionalStringCwd?optionalstringCwd?optional*string#

The working directory.

Default: Use default working directory

env?optional{ [key: string]: string }env?optionaltyping.Mapping[str, str]env?optionalMap<String, String>Env?optionalIDictionary<string, string>Env?optional*map[string]*string#

Sets environment variables for the command.

Default: Use current environment

This property overwrites, rather than appends, the existing environment.

ignoreErrors?optionalbooleanignore_errors?optionalboolignoreErrors?optionalBooleanIgnoreErrors?optionalboolIgnoreErrors?optional*bool= false#

Continue running if this command fails.

key?optionalstringkey?optionalstrkey?optionalStringKey?optionalstringKey?optional*string#

Identifier key for this command.

Default: Automatically generated based on index

Commands are executed in lexicographical order of their key names.

serviceRestartHandles?optionalInitServiceRestartHandle[]service_restart_handles?optionaltyping.List[InitServiceRestartHandle]serviceRestartHandles?optionalList<InitServiceRestartHandle>ServiceRestartHandles?optionalInitServiceRestartHandle[]ServiceRestartHandles?optional*[]InitServiceRestartHandle#

Restart the given service(s) after this command has run.

Default: Do not restart any service

testCmd?optionalstringtest_cmd?optionalstrtestCmd?optionalStringTestCmd?optionalstringTestCmd?optional*string#

Command to determine whether this command should be run.

Default: Always run the command

If the test passes (exits with error code of 0), the command is run.

waitAfterCompletion?optionalInitCommandWaitDurationwait_after_completion?optionalInitCommandWaitDurationwaitAfterCompletion?optionalInitCommandWaitDurationWaitAfterCompletion?optionalInitCommandWaitDurationWaitAfterCompletion?optionalInitCommandWaitDuration#

The duration to wait after a command has finished in case the command causes a reboot.

Default: 60 seconds

Set this value to InitCommandWaitDuration.none() if you do not want to wait for every command; InitCommandWaitDuration.forever() directs cfn-init to exit and resume only after the reboot is complete.

For Windows systems only.