cfn-stack-event-stream

A readable stream of CloudFormation stack events

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
cfn-stack-event-stream
1.0.14 years ago9 years agoMinified + gzip package size for cfn-stack-event-stream in KB

Readme

A readable stream of CloudFormation stack events.

Usage

var AWS = require('aws-sdk');
var EventStream = require('cfn-stack-event-stream');

var cfn = new AWS.CloudFormation({region: 'us-east-1'});

cfn.createStack({
    StackName: 'my-stack',
    TemplateBody: template
}, function(err) {
    if (err) throw err;
    EventStream(cfn, 'my-stack')
        .on('data', function (e) {
            console.log(e.ResourceStatus, e.ResourceType, e.ResourceStatusReason);
        })
        .on('end', function() {
            cfn.describeStacks({StackName: 'my-stack'}, function(err, data) {
                if (err) throw err;
                console.log('Result: ' + data.Stacks[0].StackStatus);
            });
        });
});

API

EventStream(cfn, stackName, options)

Returns an object-mode readable stream which emits StackEvent objects as returned by describeStackEvents
Required parameters:
  • cfn: An AWS::CloudFormation instance.
  • stackName: The name or ARN of the stack. Note that if you are reading events for a stack that is deleted or in the
process of being deleted, you need to pass the full ARN rather than the stackName.
Options:
  • lastEventId: The EventId of a StackEvent. StackEvents emitted by the resulting stream
are guaranteed not to include this event or any preceding events.