Interface AttachInitOptions
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
AttachInitOptions.Jsii$Proxy
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.ec2.*; import software.amazon.awscdk.services.iam.*; import software.amazon.awscdk.core.*; CfnResource cfnResource; Role role; UserData userData; AttachInitOptions attachInitOptions = AttachInitOptions.builder() .instanceRole(role) .platform(OperatingSystemType.LINUX) .userData(userData) // the properties below are optional .configSets(List.of("configSets")) .embedFingerprint(false) .ignoreFailures(false) .includeRole(false) .includeUrl(false) .printLog(false) .signalResource(cfnResource) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forAttachInitOptions
static final class
An implementation forAttachInitOptions
-
Method Summary
Modifier and TypeMethodDescriptionstatic AttachInitOptions.Builder
builder()
ConfigSet to activate.default Boolean
Whether to embed a hash into the userData.default Boolean
Don't fail the instance creation when cfn-init fails.default Boolean
Include --role argument when running cfn-init and cfn-signal commands.default Boolean
Include --url argument when running cfn-init and cfn-signal commands.Instance role of the consuming instance or fleet.OS Platform the init config will be used for.default Boolean
Print the results of running cfn-init to the Instance System Log.default CfnResource
When provided, signals this resource instead of the attached resource.UserData to add commands to.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getInstanceRole
Instance role of the consuming instance or fleet. -
getPlatform
OS Platform the init config will be used for. -
getUserData
UserData to add commands to. -
getConfigSets
ConfigSet to activate.Default: ['default']
-
getEmbedFingerprint
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
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
-
getIncludeRole
Include --role argument when running cfn-init and cfn-signal commands.This will be the IAM instance profile attached to the EC2 instance
Default: false
-
getIncludeUrl
Include --url argument when running cfn-init and cfn-signal commands.This will be the cloudformation endpoint in the deployed region e.g. https://cloudformation.us-east-1.amazonaws.com
Default: false
-
getPrintLog
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
-
getSignalResource
When provided, signals this resource instead of the attached resource.You can use this to support signaling LaunchTemplate while attaching AutoScalingGroup
Default: - if this property is undefined cfn-signal signals the attached resource
-
builder
- Returns:
- a
AttachInitOptions.Builder
ofAttachInitOptions
-