Class ApplyCloudFormationInitOptions

Namespace

Amazon.CDK.AWS.AutoScaling

Assembly

Amazon.CDK.AWS.AutoScaling.dll

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

public class ApplyCloudFormationInitOptions : IApplyCloudFormationInitOptions

Inheritance

object

ApplyCloudFormationInitOptions

Implements

IApplyCloudFormationInitOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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
            };

Remarks

ExampleMetadata: fixture=_generated

Constructors

ApplyCloudFormationInitOptions()

public ApplyCloudFormationInitOptions()

Properties

ConfigSets

ConfigSet to activate.

public string[]? ConfigSets { get; set; }

Property Value

string[]

Remarks

Default: ['default']

EmbedFingerprint

Force instance replacement by embedding a config fingerprint.

public bool? EmbedFingerprint { get; set; }

Property Value

bool?

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.

public bool? IgnoreFailures { get; set; }

Property Value

bool?

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.

public bool? IncludeRole { get; set; }

Property Value

bool?

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.

public bool? IncludeUrl { get; set; }

Property Value

bool?

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.

public bool? PrintLog { get; set; }

Property Value

bool?

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