Class AttachInitOptions.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<AttachInitOptions>
- Enclosing interface:
AttachInitOptions
AttachInitOptions
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.configSets
(List<String> configSets) Sets the value ofAttachInitOptions.getConfigSets()
embedFingerprint
(Boolean embedFingerprint) Sets the value ofAttachInitOptions.getEmbedFingerprint()
ignoreFailures
(Boolean ignoreFailures) Sets the value ofAttachInitOptions.getIgnoreFailures()
includeRole
(Boolean includeRole) Sets the value ofAttachInitOptions.getIncludeRole()
includeUrl
(Boolean includeUrl) Sets the value ofAttachInitOptions.getIncludeUrl()
instanceRole
(IRole instanceRole) Sets the value ofAttachInitOptions.getInstanceRole()
platform
(OperatingSystemType platform) Sets the value ofAttachInitOptions.getPlatform()
Sets the value ofAttachInitOptions.getPrintLog()
signalResource
(CfnResource signalResource) Sets the value ofAttachInitOptions.getSignalResource()
Sets the value ofAttachInitOptions.getUserData()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
instanceRole
Sets the value ofAttachInitOptions.getInstanceRole()
- Parameters:
instanceRole
- Instance role of the consuming instance or fleet. This parameter is required.- Returns:
this
-
platform
Sets the value ofAttachInitOptions.getPlatform()
- Parameters:
platform
- OS Platform the init config will be used for. This parameter is required.- Returns:
this
-
userData
Sets the value ofAttachInitOptions.getUserData()
- Parameters:
userData
- UserData to add commands to. This parameter is required.- Returns:
this
-
configSets
Sets the value ofAttachInitOptions.getConfigSets()
- Parameters:
configSets
- ConfigSet to activate.- Returns:
this
-
embedFingerprint
Sets the value ofAttachInitOptions.getEmbedFingerprint()
- Parameters:
embedFingerprint
- Whether to embed a hash into the userData. Iftrue
(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.- Returns:
this
-
ignoreFailures
Sets the value ofAttachInitOptions.getIgnoreFailures()
- Parameters:
ignoreFailures
- 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.- Returns:
this
-
includeRole
Sets the value ofAttachInitOptions.getIncludeRole()
- Parameters:
includeRole
- Include --role argument when running cfn-init and cfn-signal commands. This will be the IAM instance profile attached to the EC2 instance- Returns:
this
-
includeUrl
Sets the value ofAttachInitOptions.getIncludeUrl()
- Parameters:
includeUrl
- 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- Returns:
this
-
printLog
Sets the value ofAttachInitOptions.getPrintLog()
- Parameters:
printLog
- 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 totrue
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).
- Returns:
this
-
signalResource
Sets the value ofAttachInitOptions.getSignalResource()
- Parameters:
signalResource
- When provided, signals this resource instead of the attached resource. You can use this to support signaling LaunchTemplate while attaching AutoScalingGroup- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<AttachInitOptions>
- Returns:
- a new instance of
AttachInitOptions
- Throws:
NullPointerException
- if any required attribute was not provided
-