AttachInitOptions¶

class aws_cdk.aws_ec2.AttachInitOptions(*, instance_role, platform, user_data, config_sets=None, embed_fingerprint=None, ignore_failures=None, print_log=None)¶

Bases: object

Options for attaching a CloudFormationInit to a resource.

Parameters

instance_role (IRole) – Instance role of the consuming instance or fleet.
platform (OperatingSystemType) – OS Platform the init config will be used for.
user_data (UserData) – UserData to add commands to.
config_sets (Optional[Sequence[str]]) – ConfigSet to activate. Default: [‘default’]
embed_fingerprint (Optional[bool]) – 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
ignore_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: false
print_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 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

Attributes

config_sets¶

ConfigSet to activate.

Default: [‘default’]
Return type: Optional[List[str]]

embed_fingerprint¶

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
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]

instance_role¶

Instance role of the consuming instance or fleet.

Return type: IRole

platform¶

OS Platform the init config will be used for.

Return type: OperatingSystemType

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]

user_data¶

UserData to add commands to.

Return type: UserData