Interface IApplyCloudFormationInitOptions

Options for applying CloudFormation init to an instance or instance group.

Namespace: Amazon.CDK.AWS.AutoScaling

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IApplyCloudFormationInitOptions

Syntax (vb)

Public Interface IApplyCloudFormationInitOptions

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AutoScaling;

var applyCloudFormationInitOptions = new ApplyCloudFormationInitOptions {
    ConfigSets = new [] { "configSets" },
    EmbedFingerprint = false,
    IgnoreFailures = false,
    IncludeRole = false,
    IncludeUrl = false,
    PrintLog = false
};

Synopsis

Properties

ConfigSets	ConfigSet to activate.
EmbedFingerprint	Force instance replacement by embedding a config fingerprint.
IgnoreFailures	Don't fail the instance creation when cfn-init fails.
IncludeRole	Include --role argument when running cfn-init and cfn-signal commands.
IncludeUrl	Include --url argument when running cfn-init and cfn-signal commands.
PrintLog	Print the results of running cfn-init to the Instance System Log.

Properties

ConfigSets

ConfigSet to activate.

virtual string[] ConfigSets { get; }

Property Value

System.String[]

Remarks

Default: ['default']

EmbedFingerprint

Force instance replacement by embedding a config fingerprint.

virtual Nullable<bool> EmbedFingerprint { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

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 instances will be replaced (given an UpdatePolicy has been configured on the AutoScalingGroup).

If false, no such hash will be embedded, and if the CloudFormation Init config changes nothing will happen to the running instances. 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

IgnoreFailures

Don't fail the instance creation when cfn-init fails.

virtual Nullable<bool> IgnoreFailures { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

You can use this to prevent CloudFormation from rolling back when instances fail to start up, to help in debugging.

Default: false

IncludeRole

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

virtual Nullable<bool> IncludeRole { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

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

Default: false

IncludeUrl

Include --url argument when running cfn-init and cfn-signal commands.

virtual Nullable<bool> IncludeUrl { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

This will be the cloudformation endpoint in the deployed region e.g. https://cloudformation.us-east-1.amazonaws.com

Default: false

PrintLog

Print the results of running cfn-init to the Instance System Log.

virtual Nullable<bool> PrintLog { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

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