AWS CDK Reference

Appearance

v2.274.0

InitCommandOptions Struct ​

Options for InitCommand.

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

Example ​

ts
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 ​

cwdstringcwdstrcwdStringCwdstringCwd*string#
The working directory.

Default: Use default working directory

env{ [key: string]: string }envtyping.Mapping[str, str]envMap<String, String>EnvIDictionary<string, string>Env*map[string]*string#
Sets environment variables for the command.

Default: Use current environment

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

ignoreErrorsbooleanignore_errorsboolignoreErrorsBooleanIgnoreErrorsboolIgnoreErrors*bool= false#
Continue running if this command fails.
keystringkeystrkeyStringKeystringKey*string#
Identifier key for this command.

Default: Automatically generated based on index

Commands are executed in lexicographical order of their key names.

serviceRestartHandlesInitServiceRestartHandle[]service_restart_handlestyping.List[InitServiceRestartHandle]serviceRestartHandlesList<InitServiceRestartHandle>ServiceRestartHandlesInitServiceRestartHandle[]ServiceRestartHandles*[]InitServiceRestartHandle#
Restart the given service(s) after this command has run.

Default: Do not restart any service

testCmdstringtest_cmdstrtestCmdStringTestCmdstringTestCmd*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.

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