software.amazon.awscdk.services.ec2

Interface AttachInitOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AttachInitOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:06.500Z")
 @Stability(value=Experimental)
public interface AttachInitOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for attaching a CloudFormationInit to a resource.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static AttachInitOptions.Builder	builder()
default List<String>	getConfigSets() (experimental) ConfigSet to activate.
default Boolean	getEmbedFingerprint() (experimental) Whether to embed a hash into the userData.
default Boolean	getIgnoreFailures() (experimental) Don't fail the instance creation when cfn-init fails.
IRole	getInstanceRole() (experimental) Instance role of the consuming instance or fleet.
OperatingSystemType	getPlatform() (experimental) OS Platform the init config will be used for.
default Boolean	getPrintLog() (experimental) Print the results of running cfn-init to the Instance System Log.
UserData	getUserData() (experimental) UserData to add commands to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getInstanceRole

@Stability(value=Experimental)
 @NotNull
IRole getInstanceRole()

(experimental) Instance role of the consuming instance or fleet.

getPlatform

@Stability(value=Experimental)
 @NotNull
OperatingSystemType getPlatform()

(experimental) OS Platform the init config will be used for.

getUserData

@Stability(value=Experimental)
 @NotNull
UserData getUserData()

(experimental) UserData to add commands to.

getConfigSets

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

(experimental) ConfigSet to activate.

Default: ['default']

getEmbedFingerprint

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

(experimental) Whether to embed a hash into the userData.

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

If false, no such hash will be embedded, and if the CloudFormation Init config changes nothing will happen to the running instance.

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

builder

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

Returns:

a AttachInitOptions.Builder of AttachInitOptions