MDAA TS Docs
    Preparing search index...

    Options controlling CloudFormation Init execution behavior.

    interface InitOptionsProps {
        configSets?: string[];
        embedFingerprint?: boolean;
        ignoreFailures?: boolean;
        includeRole?: boolean;
        includeUrl?: boolean;
        printLog?: boolean;
        timeout?: number;
    }
    Index

    Properties

    configSets?: string[]

    Config set names to execute. If omitted, the "default" config set runs.

    Use cases: Selective bootstrap; Environment-specific init sequences

    AWS: CloudFormation::Init ApplyCloudFormationInitOptions configSets

    Validation: Optional; array of config set name strings

    embedFingerprint?: boolean

    Embed a config fingerprint in UserData so the instance is replaced when the init configuration changes.

    Use cases: Immutable infrastructure; Automatic replacement on config drift

    AWS: CloudFormation::Init fingerprint in UserData

    Validation: Optional; boolean

    true
    
    ignoreFailures?: boolean

    When true, instance creation continues even if cfn-init fails. Useful for debugging initialization issues without triggering rollback.

    Use cases: Init debugging; Development troubleshooting

    AWS: CloudFormation::Init ignoreFailures

    Validation: Optional; boolean

    false
    
    includeRole?: boolean

    Include --role argument when running cfn-init and cfn-signal commands, using the IAM instance profile attached to the EC2 instance.

    Use cases: Authenticated cfn-init calls; Instance profile credential passing

    AWS: cfn-init --role / cfn-signal --role

    Validation: Optional; boolean

    includeUrl?: boolean

    Include --url argument when running cfn-init and cfn-signal commands, pointing to the CloudFormation endpoint in the deployed region.

    Use cases: Custom CloudFormation endpoint; VPC endpoint routing

    AWS: cfn-init --url / cfn-signal --url

    Validation: Optional; boolean

    printLog?: boolean

    Print cfn-init output to the Instance System Log (visible in EC2 Console). By default output goes to a log file on the instance only. System log refreshes at certain lifecycle points so results may not always appear.

    Use cases: Init debugging via EC2 Console; Troubleshooting without SSH

    AWS: EC2 System Log

    Validation: Optional; boolean

    timeout?: number

    Maximum time in minutes to wait for the init configuration to be applied.

    Use cases: Long-running init timeout; Fast-fail on stuck init

    AWS: CloudFormation CreationPolicy timeout

    Validation: Optional; number (minutes)

    5