software.amazon.awscdk.services.ec2

Class AttachInitOptions.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.AttachInitOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AttachInitOptions>

Enclosing interface:

AttachInitOptions

@Stability(value=Stable)
public static final class AttachInitOptions.Builder
extends Object
implements software.amazon.jsii.Builder<AttachInitOptions>

A builder for AttachInitOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AttachInitOptions	build() Builds the configured instance.
AttachInitOptions.Builder	configSets(List<String> configSets) Sets the value of AttachInitOptions.getConfigSets()
AttachInitOptions.Builder	embedFingerprint(Boolean embedFingerprint) Sets the value of AttachInitOptions.getEmbedFingerprint()
AttachInitOptions.Builder	ignoreFailures(Boolean ignoreFailures) Sets the value of AttachInitOptions.getIgnoreFailures()
AttachInitOptions.Builder	includeRole(Boolean includeRole) Sets the value of AttachInitOptions.getIncludeRole()
AttachInitOptions.Builder	includeUrl(Boolean includeUrl) Sets the value of AttachInitOptions.getIncludeUrl()
AttachInitOptions.Builder	instanceRole(IRole instanceRole) Sets the value of AttachInitOptions.getInstanceRole()
AttachInitOptions.Builder	platform(OperatingSystemType platform) Sets the value of AttachInitOptions.getPlatform()
AttachInitOptions.Builder	printLog(Boolean printLog) Sets the value of AttachInitOptions.getPrintLog()
AttachInitOptions.Builder	signalResource(CfnResource signalResource) Sets the value of AttachInitOptions.getSignalResource()
AttachInitOptions.Builder	userData(UserData userData) Sets the value of AttachInitOptions.getUserData()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

instanceRole

@Stability(value=Stable)
public AttachInitOptions.Builder instanceRole(IRole instanceRole)

Sets the value of AttachInitOptions.getInstanceRole()

Parameters:

instanceRole - Instance role of the consuming instance or fleet. This parameter is required.

Returns:

this

platform

@Stability(value=Stable)
public AttachInitOptions.Builder platform(OperatingSystemType platform)

Sets the value of AttachInitOptions.getPlatform()

Parameters:

platform - OS Platform the init config will be used for. This parameter is required.

Returns:

this

userData

@Stability(value=Stable)
public AttachInitOptions.Builder userData(UserData userData)

Sets the value of AttachInitOptions.getUserData()

Parameters:

userData - UserData to add commands to. This parameter is required.

Returns:

this

configSets

@Stability(value=Stable)
public AttachInitOptions.Builder configSets(List<String> configSets)

Sets the value of AttachInitOptions.getConfigSets()

Parameters:

configSets - ConfigSet to activate.

Returns:

this

embedFingerprint

@Stability(value=Stable)
public AttachInitOptions.Builder embedFingerprint(Boolean embedFingerprint)

Sets the value of AttachInitOptions.getEmbedFingerprint()

Parameters:

embedFingerprint - 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.

Returns:

this

ignoreFailures

@Stability(value=Stable)
public AttachInitOptions.Builder ignoreFailures(Boolean ignoreFailures)

Sets the value of AttachInitOptions.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

@Stability(value=Stable)
public AttachInitOptions.Builder includeRole(Boolean includeRole)

Sets the value of AttachInitOptions.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

@Stability(value=Stable)
public AttachInitOptions.Builder includeUrl(Boolean includeUrl)

Sets the value of AttachInitOptions.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

@Stability(value=Stable)
public AttachInitOptions.Builder printLog(Boolean printLog)

Sets the value of AttachInitOptions.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 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).

Returns:

this

signalResource

@Stability(value=Stable)
public AttachInitOptions.Builder signalResource(CfnResource signalResource)

Sets the value of AttachInitOptions.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

@Stability(value=Stable)
public AttachInitOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<AttachInitOptions>

Returns:

a new instance of AttachInitOptions

Throws:

NullPointerException - if any required attribute was not provided