Class: Cloudformation

Cloudformation

new Cloudformation(event, context, cb)

Provides a simple interface for working with Custom Cloudformation Resource events.
Parameters:
Name Type Description
event object The event being received from AWS Lambda. The content of this object is determined greatly by the resource it is being invoked against. See here
Properties
Name Type Attributes Default Description
RequestType string The type of Cloudformation request
ResponseURL string The response URL identifies a pre-signed S3 bucket
StackId string The Amazon Resource Name (ARN) that identifies the stack
RequestId string A unique ID for the request
ResourceType string The custom named resource type as defined in the cloudformation
LogicalResourceId string The template developer-chosen name (logical ID) of the custom resource in the AWS CloudFormation template
PhysicalResourceId string <optional>
 null An ID of the associated AWS resource created by the custom resource. Null on Create
ResourceProperties object The properties defined by the custom resource definition
OldResourceProperties object <optional>
 null Used only for Update requests. Contains the resource properties that were declared previous to the update request
context object The context of the event being received See here
cb lambdaCallback The callback function passed through from Lambda
Source:
Tutorials:
See:

Extends

Members

cb :function

The response object allowing any extending class to respond to Cloudformation.
Type:
  • function
Inherited From:
Source:

context :Object

The raw context object received by Lambda
Type:
  • Object
Inherited From:
Source:

event :Object

The raw event received by Lambda
Type:
  • Object
Inherited From:
Source:

id :null|String

Returns the PhysicalResourceId that is associated with the custom resource that this lambda function controls. For Create requests, this will return null.
Type:
  • null | String
Source:

properties :Object

Returns the properties for the custom Cloudformation request without the accompanying ServiceToken.
Type:
  • Object
Source:

type :String

Return the type of request. Typically this will member will return "create", "update" or "delete". This member is used to determine which action the lambda function should perform.
Type:
  • String
Source:
See:

Methods

perform()

Executes the action determined by the request type that Cloudformation has invoked this function with.
Source: