1.204.0

interface ApplyCloudFormationInitOptions

LanguageType name
.NETAmazon.CDK.AWS.AutoScaling.ApplyCloudFormationInitOptions
Javasoftware.amazon.awscdk.services.autoscaling.ApplyCloudFormationInitOptions
Pythonaws_cdk.aws_autoscaling.ApplyCloudFormationInitOptions
TypeScript (source)@aws-cdk/aws-autoscaling » ApplyCloudFormationInitOptions

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as autoscaling from '@aws-cdk/aws-autoscaling';
const applyCloudFormationInitOptions: autoscaling.ApplyCloudFormationInitOptions = {
  configSets: ['configSets'],
  embedFingerprint: false,
  ignoreFailures: false,
  includeRole: false,
  includeUrl: false,
  printLog: false,
};

Properties

NameTypeDescription
configSets?string[]ConfigSet to activate.
embedFingerprint?booleanForce instance replacement by embedding a config fingerprint.
ignoreFailures?booleanDon't fail the instance creation when cfn-init fails.
includeRole?booleanInclude --role argument when running cfn-init and cfn-signal commands.
includeUrl?booleanInclude --url argument when running cfn-init and cfn-signal commands.
printLog?booleanPrint the results of running cfn-init to the Instance System Log.

configSets?

Type: string[] (optional, default: ['default'])

ConfigSet to activate.

embedFingerprint?

Type: boolean (optional, default: true)

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

ignoreFailures?

Type: boolean (optional, default: false)

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.

includeRole?

Type: boolean (optional, default: false)

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

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

includeUrl?

Type: boolean (optional, default: false)

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

printLog?

Type: boolean (optional, default: true)

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).

← PreviousNext →