software.amazon.awscdk.services.ec2

Interface InitCommandOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

InitCommandOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.443Z")
 @Stability(value=Stable)
public interface InitCommandOptions
extends software.amazon.jsii.JsiiSerializable

Options for InitCommand.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 InitServiceRestartHandle handle = new InitServiceRestartHandle();
 CloudFormationInit.fromElements(InitCommand.shellCommand("/usr/bin/custom-nginx-install.sh", InitCommandOptions.builder().serviceRestartHandles(List.of(handle)).build()), InitService.enable("nginx", InitServiceOptions.builder().serviceRestartHandle(handle).build()));
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	InitCommandOptions.Builder A builder for InitCommandOptions
static class	InitCommandOptions.Jsii$Proxy An implementation for InitCommandOptions

Method Summary

Modifier and Type	Method and Description
static InitCommandOptions.Builder	builder()
default String	getCwd() The working directory.
default Map<String,String>	getEnv() Sets environment variables for the command.
default Boolean	getIgnoreErrors() Continue running if this command fails.
default String	getKey() Identifier key for this command.
default List<InitServiceRestartHandle>	getServiceRestartHandles() Restart the given service(s) after this command has run.
default String	getTestCmd() Command to determine whether this command should be run.
default InitCommandWaitDuration	getWaitAfterCompletion() The duration to wait after a command has finished in case the command causes a reboot.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCwd

@Stability(value=Stable)
 @Nullable
default String getCwd()

The working directory.

Default: - Use default working directory

getEnv

@Stability(value=Stable)
 @Nullable
default Map<String,String> getEnv()

Sets environment variables for the command.

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

Default: - Use current environment

getIgnoreErrors

@Stability(value=Stable)
 @Nullable
default Boolean getIgnoreErrors()

Continue running if this command fails.

Default: false

getKey

@Stability(value=Stable)
 @Nullable
default String getKey()

Identifier key for this command.

Commands are executed in lexicographical order of their key names.

Default: - Automatically generated based on index

getServiceRestartHandles

@Stability(value=Stable)
 @Nullable
default List<InitServiceRestartHandle> getServiceRestartHandles()

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

Default: - Do not restart any service

getTestCmd

@Stability(value=Stable)
 @Nullable
default String getTestCmd()

Command to determine whether this command should be run.

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

Default: - Always run the command

getWaitAfterCompletion

@Stability(value=Stable)
 @Nullable
default InitCommandWaitDuration getWaitAfterCompletion()

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

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.

Default: - 60 seconds

builder

@Stability(value=Stable)
static InitCommandOptions.Builder builder()

Returns:

a InitCommandOptions.Builder of InitCommandOptions