Package software.amazon.awscdk.services.ec2

Class ApplyCloudFormationInitOptions.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.ApplyCloudFormationInitOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApplyCloudFormationInitOptions>

Enclosing interface:

ApplyCloudFormationInitOptions

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

A builder for ApplyCloudFormationInitOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApplyCloudFormationInitOptions	build()	Builds the configured instance.
ApplyCloudFormationInitOptions.Builder	configSets(List<String> configSets)	Sets the value of ApplyCloudFormationInitOptions.getConfigSets()
ApplyCloudFormationInitOptions.Builder	embedFingerprint(Boolean embedFingerprint)	Sets the value of ApplyCloudFormationInitOptions.getEmbedFingerprint()
ApplyCloudFormationInitOptions.Builder	ignoreFailures(Boolean ignoreFailures)	Sets the value of ApplyCloudFormationInitOptions.getIgnoreFailures()
ApplyCloudFormationInitOptions.Builder	includeRole(Boolean includeRole)	Sets the value of ApplyCloudFormationInitOptions.getIncludeRole()
ApplyCloudFormationInitOptions.Builder	includeUrl(Boolean includeUrl)	Sets the value of ApplyCloudFormationInitOptions.getIncludeUrl()
ApplyCloudFormationInitOptions.Builder	printLog(Boolean printLog)	Sets the value of ApplyCloudFormationInitOptions.getPrintLog()
ApplyCloudFormationInitOptions.Builder	timeout(Duration timeout)	Sets the value of ApplyCloudFormationInitOptions.getTimeout()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

configSets

@Stability(Stable)
public ApplyCloudFormationInitOptions.Builder configSets(List<String> configSets)

Sets the value of ApplyCloudFormationInitOptions.getConfigSets()

Parameters:

configSets - ConfigSet to activate.

Returns:

this

embedFingerprint

@Stability(Stable)
public ApplyCloudFormationInitOptions.Builder embedFingerprint(Boolean embedFingerprint)

Sets the value of ApplyCloudFormationInitOptions.getEmbedFingerprint()

Parameters:

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

Returns:

this

ignoreFailures

@Stability(Stable)
public ApplyCloudFormationInitOptions.Builder ignoreFailures(Boolean ignoreFailures)

Sets the value of ApplyCloudFormationInitOptions.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(Stable)
public ApplyCloudFormationInitOptions.Builder includeRole(Boolean includeRole)

Sets the value of ApplyCloudFormationInitOptions.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(Stable)
public ApplyCloudFormationInitOptions.Builder includeUrl(Boolean includeUrl)

Sets the value of ApplyCloudFormationInitOptions.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(Stable)
public ApplyCloudFormationInitOptions.Builder printLog(Boolean printLog)

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

timeout

@Stability(Stable)
public ApplyCloudFormationInitOptions.Builder timeout(Duration timeout)

Sets the value of ApplyCloudFormationInitOptions.getTimeout()

Parameters:

timeout - Timeout waiting for the configuration to be applied.

Returns:

this

build

@Stability(Stable)
public ApplyCloudFormationInitOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ApplyCloudFormationInitOptions

Throws:

NullPointerException - if any required attribute was not provided