software.amazon.awscdk.services.ec2

Interface ApplyCloudFormationInitOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApplyCloudFormationInitOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:16.946Z")
 @Stability(value=Experimental)
public interface ApplyCloudFormationInitOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for applying CloudFormation init to an instance or instance group.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ApplyCloudFormationInitOptions.Builder	builder()
default List<String>	getConfigSets() (experimental) ConfigSet to activate.
default Boolean	getEmbedFingerprint() (experimental) Force instance replacement by embedding a config fingerprint.
default Boolean	getIgnoreFailures() (experimental) Don't fail the instance creation when cfn-init fails.
default Boolean	getPrintLog() (experimental) Print the results of running cfn-init to the Instance System Log.
default Duration	getTimeout() (experimental) Timeout waiting for the configuration to be applied.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getConfigSets

@Stability(value=Experimental)
 @Nullable
default List<String> getConfigSets()

(experimental) ConfigSet to activate.

Default: ['default']

getEmbedFingerprint

@Stability(value=Experimental)
 @Nullable
default Boolean getEmbedFingerprint()

(experimental) Force instance replacement by embedding a config fingerprint.

If true (the default), a hash of the config will be embedded into the UserData, so that if the config changes, the UserData changes.

• If the EC2 instance is instance-store backed or userDataCausesReplacement is set, this will cause the instance to be replaced and the new configuration to be applied.
• If the instance is EBS-backed and userDataCausesReplacement is not set, the change of UserData will make the instance restart but not be replaced, and the configuration will not be applied automatically.

If false, no hash will be embedded, and if the CloudFormation Init config changes nothing will happen to the running instance. If a config update introduces errors, you will not notice until after the CloudFormation deployment successfully finishes and the next instance fails to launch.

Default: true

getIgnoreFailures

@Stability(value=Experimental)
 @Nullable
default Boolean getIgnoreFailures()

(experimental) Don't fail the instance creation when cfn-init fails.

You can use this to prevent CloudFormation from rolling back when instances fail to start up, to help in debugging.

Default: false

getPrintLog

@Stability(value=Experimental)
 @Nullable
default Boolean getPrintLog()

(experimental) Print the results of running cfn-init to the Instance System Log.

By default, the output of running cfn-init is written to a log file on the instance. Set this to true to print it to the System Log (visible from the EC2 Console), false to not print it.

(Be aware that the system log is refreshed at certain points in time of the instance life cycle, and successful execution may not always show up).

Default: true

getTimeout

@Stability(value=Experimental)
 @Nullable
default Duration getTimeout()

(experimental) Timeout waiting for the configuration to be applied.

Default: Duration.minutes(5)

builder

@Stability(value=Experimental)
static ApplyCloudFormationInitOptions.Builder builder()

Returns:

a ApplyCloudFormationInitOptions.Builder of ApplyCloudFormationInitOptions