AttachInitOptions

class aws_cdk.aws_ec2.AttachInitOptions(*, instance_role, platform, user_data, config_sets=None, embed_fingerprint=None, ignore_failures=None, include_role=None, include_url=None, print_log=None, signal_resource=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
include_role (Optional[bool]) – Include –role argument when running cfn-init and cfn-signal commands. This will be the IAM instance profile attached to the EC2 instance Default: false
include_url (Optional[bool]) – 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 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
signal_resource (Optional[CfnResource]) – When provided, signals this resource instead of the attached resource. You can use this to support signaling LaunchTemplate while attaching AutoScalingGroup Default: - if this property is undefined cfn-signal signals the attached resource

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_ec2 as ec2
from aws_cdk import aws_iam as iam

# cfn_resource: cdk.CfnResource
# role: iam.Role
# user_data: ec2.UserData

attach_init_options = ec2.AttachInitOptions(
    instance_role=role,
    platform=ec2.OperatingSystemType.LINUX,
    user_data=user_data,

    # the properties below are optional
    config_sets=["configSets"],
    embed_fingerprint=False,
    ignore_failures=False,
    include_role=False,
    include_url=False,
    print_log=False,
    signal_resource=cfn_resource
)

Attributes

config_sets

ConfigSet to activate.

Default:: [‘default’]

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

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

include_role

Include –role argument when running cfn-init and cfn-signal commands.

This will be the IAM instance profile attached to the EC2 instance

Default:: false

include_url

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

Default:: false

instance_role: Instance role of the consuming instance or fleet.

platform: OS Platform the init config will be used for.

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

signal_resource

When provided, signals this resource instead of the attached resource.

You can use this to support signaling LaunchTemplate while attaching AutoScalingGroup

Default:

if this property is undefined cfn-signal signals the attached resource

user_data: UserData to add commands to.