ApplyCloudFormationInitOptions¶
-
class
aws_cdk.aws_ec2.
ApplyCloudFormationInitOptions
(*, config_sets=None, embed_fingerprint=None, ignore_failures=None, print_log=None, timeout=None)¶ Bases:
object
Options for applying CloudFormation init to an instance or instance group.
- Parameters
config_sets (
Optional
[List
[str
]]) – ConfigSet to activate. Default: [‘default’]embed_fingerprint (
Optional
[bool
]) – Force instance replacement by embedding a config fingerprint. Iftrue
(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 oruserDataCausesReplacement
is set, this will cause the instance to be replaced and the new configuration to be applied. - If the instance is EBS-backed anduserDataCausesReplacement
is not set, the change of UserData will make the instance restart but not be replaced, and the configuration will not be applied automatically. Iffalse
, 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. Default: trueignore_failures (
Optional
[bool
]) – 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: falseprint_log (
Optional
[bool
]) – 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). Default: truetimeout (
Optional
[Duration
]) – Timeout waiting for the configuration to be applied. Default: Duration.minutes(5)
Attributes
-
config_sets
¶ ConfigSet to activate.
- Default
[‘default’]
- Return type
Optional
[List
[str
]]
-
embed_fingerprint
¶ 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.- Default
true
- Return type
Optional
[bool
]
-
ignore_failures
¶ 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
- Return type
Optional
[bool
]
-
print_log
¶ 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
- Return type
Optional
[bool
]