Welcome to Wolkenkratzer!

Wolkenkratzer is a Javascript library that allows you to programmatically generate AWS CloudFormation templates. It can import and modify existing templates, create templates based off of existing resources in AWS, and output templates in JSON and Yaml.

Who this is for

AWS CloudFormation is a great tool for defining your cloud infrastructure in a declarative manner. This is sufficient for one-off projects, but using a generator library like Wolkenkratzer can be very useful if you need dynamically generated templates and have lots of custom logic.

Relying on Wolkenkratzer's internal validation can also help catch bugs early in development, which can cut down the number of times you need to launch a stack in CloudFormation during testing.

CloudFormation Resource support

The library uses the CloudFormation Resource Specification to achieve 100% feature parity with CloudFormation. The specification is parsed by Wolkenkratzer at runtime, so adding support for new Cloudformation resources only requires updating the spec file.

Validation

Wolkenkratzer Template methods perform validation to ensure that valid templates are generated, and syntax errors are caught early in development. The following validation checks are supported:

Resource validation

When you create a resource, Wolkenkratzer will validate whether the resource is valid. If it is invalid, an Error will be thrown. For example, if you try to create an EC2 instance without an ImageId (which is required), the method will fail:

const { EC2, Template } = require('wolkenkratzer');

const t = Template().add(EC2.Instance('Instance'));

console.log(JSON.stringify(t.build(), null, 2));

SyntaxError: ImageId is required but is not present in Instance

Template validation

Template validations that ensure that the template is logically correct and valid are also done. For example, creating a Ref to a Parameter that does not exist in the template throws an error:

const { EC2, Parameter, Ref, Template } = require('wolkenkratzer');

const t = Template()
  .add(
    Parameter('IType', {
      Type: 'String'
    })
  )
  .add(
    EC2.Instance('Instance', {
      ImageId: 'ami-12345678',
      InstanceType: Ref('YType')
    })
  );

console.log(JSON.stringify(t.build(), null, 2));

SyntaxError: Could not find {"kind":"Ref","Ref":"YType"}

Template manipulation

In Wolkenkratzer, Templates are always immutable objects. When you call one of the methods in the Template API, it will return a new and immutable Template object. This allows you to chain multiple API calls together in a row. The following code shows how this works in practice:

const { Template, Output, S3, Ref } = require('wolkenkratzer');

const t = Template()
  .add(S3.Bucket('Bucket'))
  .add(Output('BucketName', { Value: Ref('Bucket') }));

console.log(JSON.stringify(t.build(), null, 2));

Results in:

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "Bucket": {
      "Type": "AWS::S3::Bucket",
      "Properties": {}
    }
  },
  "Outputs": {
    "BucketName": {
      "Value": {
        "Ref": "Bucket"
      }
    }
  }
}

Calling javascript Template() returns an empty Template object. The line javascript .add(S3.Bucket('Bucket')) returns a new Template object with an S3 Bucket, and the javascript .add(Output('BucketName', { Value: Ref('Bucket') }));adds an output block.

Import existing templates

Existing templates can be imported as Wolkenkratzer Template objects and manipulated. The following example reads in an existing JSON-formatted template and outputs it as a YAML file:

const { Template } = require('wolkenkratzer');
const { readFile } = require('fs');

readFile('./s3.json', (err, data) => {
  const t = Template().import(data.toString());
  console.log(t.yaml());
});

At this time only JSON templates are supported with the import() function.

Generate CloudFormation templates based off of existing AWS resources

The Transform API makes AWS SDK calls to your account to read the state of a given resource, and returns a Wolkenkratzer resource that can be added to a Template. The first parameter is the name of the resource in your account. The second parameter is the SDK service object that will make the API calls (provided by the user so that it can be configured as needed to set proxy, region, etc). The third parameter is the logical name of the resulting resource, but this is optional.

Please note that this API is not yet complete, and not all resources are supported at this time.

const { Template, Transform } = require('wolkenkratzer');
const AWS = require('aws-sdk');
AWS.config.region = 'us-east-1';
const S3 = new AWS.S3();
const EC2 = new AWS.EC2();

async function buildTemplate() {
  const policy = await Transform.S3.BucketPolicy(
    'arminhammer-bucket',
    S3,
    'Policy'
  );
  const bucket = await Transform.S3.Bucket(
    'arminhammer-test-bucket',
    S3,
    'Bucket'
  );
  const egress = await Transform.EC2.EgressOnlyInternetGateway(
    'eigw-11114ea8cb7e777c5',
    AWS,
    'EgressInternetGateway'
  );
  const t = Template()
    .add(policy)
    .add(bucket)
    .add(egress);
  console.log(JSON.stringify(t.build(), null, 2));
}

buildTemplate();

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "Policy": {
      "Type": "AWS::S3::BucketPolicy",
      "Properties": {
        "Bucket": "arminhammer-cloudtrail",
        "PolicyDocument":
          "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"AWSCloudTrailAclCheck20150319\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"cloudtrail.amazonaws.com\"},\"Action\":\"s3:GetBucketAcl\",\"Resource\":\"arn:aws:s3:::arminhammer-bucket\"},{\"Sid\":\"AWSCloudTrailWrite20150319\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"cloudtrail.amazonaws.com\"},\"Action\":\"s3:PutObject\",\"Resource\":\"arn:aws:s3:::arminhammer-bucket/AWSLogs/01234567890/*\",\"Condition\":{\"StringEquals\":{\"s3:x-amz-acl\":\"bucket-owner-full-control\"}}}]}"
      }
    },
    "Bucket": {
      "Type": "AWS::S3::Bucket",
      "Properties": {
        "BucketName": "arminhammer-test-bucket",
        "VersioningConfiguration": {
          "Status": "Enabled"
        },
        "CorsConfiguration": {
          "CORSRules": [
            {
              "MaxAge": 3000
            },
            {
              "MaxAge": 3000
            }
          ]
        },
        "LoggingConfiguration": {
          "DestinationBucketName": "logging.bucket.com",
          "LogFilePrefix": "wk/"
        },
        "Tags": [
          {
            "Key": "Key1",
            "Value": "Key1"
          },
          {
            "Key": "Key0",
            "Value": "Value0"
          }
        ],
        "WebsiteConfiguration": {
          "RedirectAllRequestsTo": {
            "HostName": "cache.bucket.com",
            "Protocol": "https"
          },
          "RoutingRules": []
        },
        "AccessControl": {
          "Owner": {
            "DisplayName": "arminhammer",
            "ID":
              "892781d54cee55f628a83c3c111162b42d6183f987d97ccbbc6cbe43095aa0ce"
          },
          "Grants": [
            {
              "Grantee": {
                "DisplayName": "arminhammer",
                "ID":
                  "892781d54cee55f628a83c3c111162b42d6183f987d97ccbbc6cbe43095aa0ce",
                "Type": "CanonicalUser"
              },
              "Permission": "FULL_CONTROL"
            },
            {
              "Grantee": {
                "Type": "Group",
                "URI":
                  "http://acs.amazonaws.com/groups/global/AuthenticatedUsers"
              },
              "Permission": "READ"
            },
            {
              "Grantee": {
                "Type": "Group",
                "URI":
                  "http://acs.amazonaws.com/groups/global/AuthenticatedUsers"
              },
              "Permission": "READ_ACP"
            }
          ]
        }
      }
    },
    "EgressInternetGateway": {
      "Type": "AWS::EC2::EgressOnlyInternetGateway",
      "Properties": {
        "VpcId": "vpc-de45c711"
      }
    }
  }
}

Template elements

Resource

Wolkenkratzer exports all of the AWS services as objects which you can import. Each resource for that service has a corresponding method. The method has two arguments: 1) the logical name of the resource, and 2) the properties of the resource. In the following example, an EC2 instance is created with a logical name Instance, and ImageId and InstanceType property values:

const { EC2, Template } = require('wolkenkratzer');

const t = Template().add(
  EC2.Instance('Instance', {
    ImageId: 'ami-12345678',
    InstanceType: 't2-micro'
  })
);

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "Instance": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": "ami-12345678",
        "InstanceType": "t2-micro"
      }
    }
  }
}

Resource Attributes

Add a CreationPolicy

CreationPolicies are supported with add(). The first parameter is the name of the resource in the template that the CreationPolicy is for, and the second is the body of the policy.

const {
  AutoScaling,
  CreationPolicy,
  FnBase64,
  FnGetAZs,
  FnJoin,
  Pseudo,
  Ref,
  Template
} = require('wolkenkratzer');

const t = Template()
  .add(
    AutoScaling.LaunchConfiguration('LaunchConfig', {
      ImageId: 'ami-16d18a7e',
      InstanceType: 't2.micro',
      UserData: FnBase64(
        FnJoin('', [
          '#!/bin/bash -xe\n',
          'yum install -y aws-cfn-bootstrap\n',
          '/opt/aws/bin/cfn-signal -e 0 --stack ',
          Ref(Pseudo.AWS_STACK_NAME),
          ' --resource AutoScalingGroup ',
          ' --region ',
          Ref(Pseudo.AWS_REGION),
          '\n'
        ])
      )
    })
  )
  .add(
    AutoScaling.AutoScalingGroup('AutoScalingGroup', {
      AvailabilityZones: FnGetAZs(),
      DesiredCapacity: '3',
      LaunchConfigurationName: Ref('LaunchConfig'),
      MaxSize: '4',
      MinSize: '1'
    })
  )
  .add(
    CreationPolicy('AutoScalingGroup', {
      ResourceSignal: {
        Count: '3',
        Timeout: 'PT15M'
      }
    })
  );

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "LaunchConfig": {
      "Type": "AWS::AutoScaling::LaunchConfiguration",
      "Properties": {
        "ImageId": "ami-16d18a7e",
        "InstanceType": "t2.micro",
        "UserData": {
          "Fn::Base64": {
            "Fn::Join": [
              "",
              [
                "#!/bin/bash -xe\n",
                "yum install -y aws-cfn-bootstrap\n",
                "/opt/aws/bin/cfn-signal -e 0 --stack ",
                {
                  "Ref": "AWS::StackName"
                },
                " --resource AutoScalingGroup ",
                " --region ",
                {
                  "Ref": "AWS::Region"
                },
                "\n"
              ]
            ]
          }
        }
      }
    },
    "AutoScalingGroup": {
      "Type": "AWS::AutoScaling::AutoScalingGroup",
      "Properties": {
        "AvailabilityZones": {
          "Fn::GetAZs": {
            "Ref": "AWS::Region"
          }
        },
        "DesiredCapacity": "3",
        "LaunchConfigurationName": {
          "Ref": "LaunchConfig"
        },
        "MaxSize": "4",
        "MinSize": "1"
      },
      "CreationPolicy": {
        "ResourceSignal": {
          "Count": "3",
          "Timeout": "PT15M"
        }
      }
    }
  }
}

Add a UpdatePolicy

Similar to CreationPolicies, UpdatePolicy blocks are also supported with add(). The first parameter is the name of the resource in the template that the UpdatePolicy is for, and the second is the body of the policy.

const {
  AutoScaling,
  FnBase64,
  FnGetAZs,
  FnJoin,
  Pseudo,
  Ref,
  Template,
  UpdatePolicy
} = require('wolkenkratzer');

const t = Template()
  .add(
    AutoScaling.LaunchConfiguration('LaunchConfig', {
      ImageId: 'ami-16d18a7e',
      InstanceType: 't2.micro',
      UserData: FnBase64(
        FnJoin('', [
          '#!/bin/bash -xe\n',
          'yum install -y aws-cfn-bootstrap\n',
          '/opt/aws/bin/cfn-signal -e 0 --stack ',
          Ref(Pseudo.AWS_STACK_NAME),
          ' --resource AutoScalingGroup ',
          ' --region ',
          Ref(Pseudo.AWS_REGION),
          '\n'
        ])
      )
    })
  )
  .add(
    AutoScaling.AutoScalingGroup('AutoScalingGroup', {
      AvailabilityZones: FnGetAZs(),
      DesiredCapacity: '3',
      LaunchConfigurationName: Ref('LaunchConfig'),
      MaxSize: '4',
      MinSize: '1'
    })
  )
  .add(
    UpdatePolicy('AutoScalingGroup', {
      AutoScalingScheduledAction: {
        IgnoreUnmodifiedGroupSizeProperties: 'true'
      },
      AutoScalingRollingUpdate: {
        MinInstancesInService: '1',
        MaxBatchSize: '2',
        PauseTime: 'PT1M',
        WaitOnResourceSignals: 'true'
      }
    })
  );

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "LaunchConfig": {
      "Type": "AWS::AutoScaling::LaunchConfiguration",
      "Properties": {
        "ImageId": "ami-16d18a7e",
        "InstanceType": "t2.micro",
        "UserData": {
          "Fn::Base64": {
            "Fn::Join": [
              "",
              [
                "#!/bin/bash -xe\n",
                "yum install -y aws-cfn-bootstrap\n",
                "/opt/aws/bin/cfn-signal -e 0 --stack ",
                {
                  "Ref": "AWS::StackName"
                },
                " --resource AutoScalingGroup ",
                " --region ",
                {
                  "Ref": "AWS::Region"
                },
                "\n"
              ]
            ]
          }
        }
      }
    },
    "AutoScalingGroup": {
      "Type": "AWS::AutoScaling::AutoScalingGroup",
      "Properties": {
        "AvailabilityZones": {
          "Fn::GetAZs": {
            "Ref": "AWS::Region"
          }
        },
        "DesiredCapacity": "3",
        "LaunchConfigurationName": {
          "Ref": "LaunchConfig"
        },
        "MaxSize": "4",
        "MinSize": "1"
      },
      "UpdatePolicy": {
        "AutoScalingScheduledAction": {
          "IgnoreUnmodifiedGroupSizeProperties": "true"
        },
        "AutoScalingRollingUpdate": {
          "MinInstancesInService": "1",
          "MaxBatchSize": "2",
          "PauseTime": "PT1M",
          "WaitOnResourceSignals": "true"
        }
      }
    }
  }
}

Add a DeletionPolicy

DeletionPolicy blocks are supported with add():

const { DeletionPolicy, S3, Template } = require('wolkenkratzer');

const t = Template()
  .add(S3.Bucket('myS3Bucket'))
  .add(DeletionPolicy('myS3Bucket', 'Retain'));

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "myS3Bucket": {
      "Type": "AWS::S3::Bucket",
      "DeletionPolicy": "Retain"
    }
  }
}

Add a DependsOn

DependsOn blocks can be added to any resource with add():

const { DependsOn, S3, Template } = require('wolkenkratzer');

const t = Template()
  .add(S3.Bucket('firstBucket'))
  .add(S3.Bucket('secondBucket'))
  .add(DependsOn('secondBucket', 'firstBucket'));

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "firstBucket": {
      "Type": "AWS::S3::Bucket"
    },
    "secondBucket": {
      "Type": "AWS::S3::Bucket",
      "DependsOn": "firstBucket"
    }
  }
}

Add a Metadata to a Resource

Metadata blocks can be added to any Resource with the add() method. Please not that the in Wolkenkratzer, the type for a Metadata of a Resource is ResourceMetadata, to avoid conflicting with the Template Metadata block.

const { ResourceMetadata, S3, Template } = require('wolkenkratzer');

const t = Template()
  .add(S3.Bucket('firstBucket'))
  .add(
    ResourceMetadata('firstBucket', {
      Object1: 'Location1',
      Object2: 'Location2'
    })
  );

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "firstBucket": {
      "Type": "AWS::S3::Bucket",
      "Metadata": {
        "Object1": "Location1",
        "Object2": "Location2"
      }
    }
  }
}

Parameter

Template Parameters are supported. The first parameter of the Parameter function is the logical name of the Parameter, and the second is an object that defines the attributes of the Parameter (i.e Type, Default):

const { EC2, Parameter, Ref, Template } = require('wolkenkratzer');

const t = Template()
  .add(
    Parameter('IType', {
      Type: 'String'
    })
  )
  .add(
    EC2.Instance('Instance', {
      ImageId: 'ami-12345678',
      InstanceType: Ref('IType')
    })
  );

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "Instance": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": "ami-12345678",
        "InstanceType": {
          "Ref": "IType"
        }
      }
    }
  },
  "Parameters": {
    "IType": {
      "Type": "String"
    }
  }
}

Output

Template Output blocks are supported and can be added to the Template object with the add method. The first parameter is the logical name of the Output block, and the second parameter is an object consisting of the attributes of the Output. Description, Value, Export & Export.Name, and Condition are supported as attribute keys.

const { EC2, Output, Ref, Template } = require('wolkenkratzer');

const t = Template()
  .add(
    EC2.Instance('Instance', {
      ImageId: 'ami-12345678',
      InstanceType: 't2-micro'
    })
  )
  .add(
    Output('InstanceOutput', {
      Name: 'InstanceOutput',
      Value: Ref('Instance')
    })
  );

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "Instance": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": "ami-12345678",
        "InstanceType": "t2-micro"
      }
    }
  },
  "Outputs": {
    "InstanceOutput": {
      "Name": "InstanceOutput",
      "Value": {
        "Ref": "Instance"
      }
    }
  }
}

Condition

Template Condition blocks can be added to a Template with the add() method. They can then be referenced in Resources:

const {
  Condition,
  FnEquals,
  Pseudo,
  Ref,
  S3,
  Template
} = require('wolkenkratzer');

const t = Template()
  .add(Condition('isProd', FnEquals(Ref(Pseudo.AWS_REGION), 'us-east-1')))
  .add(S3.Bucket('Bucket', null, { Condition: 'isProd' }));

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "Bucket": {
      "Type": "AWS::S3::Bucket",
      "Condition": "isProd"
    }
  },
  "Conditions": {
    "isProd": {
      "Fn::Equals": [
        {
          "Ref": "AWS::Region"
        },
        "us-east-1"
      ]
    }
  }
}

Mapping

Template Mapping blocks can be added to a Template with add(). The Mapping() function takes three arguments. The first one is the top-level mapping group, the second one is the next level, and the third one is the third level with the contents of the map. When putting together a complex Mapping block, you can call Mapping() multiple times with the same first and second level keys. The function will continue to add the new blocks to the existing Mapping block.

const { Mapping, Template } = require('wolkenkratzer');

const t = Template()
  .add(
    Mapping('RegionMap', 'us-east-1', {
      S3hostedzoneID: 'Z3AQBSTGFYJSTF',
      websiteendpoint: 's3-website-us-east-1.amazonaws.com'
    })
  )
  .add(
    Mapping('RegionMap', 'us-west-1', {
      S3hostedzoneID: 'Z2F56UZL2M1ACD',
      websiteendpoint: 's3-website-us-west-1.amazonaws.com'
    })
  );

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {},
  "Mappings": {
    "RegionMap": {
      "us-east-1": {
        "S3hostedzoneID": "Z3AQBSTGFYJSTF",
        "websiteendpoint": "s3-website-us-east-1.amazonaws.com"
      },
      "us-west-1": {
        "S3hostedzoneID": "Z2F56UZL2M1ACD",
        "websiteendpoint": "s3-website-us-west-1.amazonaws.com"
      }
    }
  }
}

Description

Template Descriptions are supported. Add one with add(), and remove it with removeDescription().

const { EC2, Description, Template } = require('wolkenkratzer');

const t = Template()
  .add(
    EC2.Instance('Instance', {
      ImageId: 'ami-12345678',
      InstanceType: 't2-micro'
    })
  )
  .add(Description('This is a sample description'));

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "Instance": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": "ami-12345678",
        "InstanceType": "t2-micro"
      }
    }
  },
  "Description": "This is a sample description"
}

Template API

add

The add() method adds a new element to the template, and returns a new Template object. You can use the add method to add Resources, Parameters, Outputs, Conditions, the template Description, and Mappings.

You can also use add() to add a CreationPolicy, UpdatePolicy, DeletionPolicy, Metadata block to a Resource element.

Add a Resource

Wolkenkratzer exports all of the AWS services as objects which you can import. Each resource for that service has a corresponding method. The method has two arguments: 1) the logical name of the resource, and 2) the properties of the resource. In the following example, an EC2 instance is created with a logical name Instance, and ImageId and InstanceType property values:

const { EC2, Template } = require('wolkenkratzer');

const t = Template().add(
  EC2.Instance('Instance', {
    ImageId: 'ami-12345678',
    InstanceType: 't2-micro'
  })
);

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "Instance": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": "ami-12345678",
        "InstanceType": "t2-micro"
      }
    }
  }
}

The add() method also supports arrays of Resources:

const { EC2, Template } = require('wolkenkratzer');

const instances = [
  { ImageId: 'ami-12345678', suffix: 'Web' },
  { ImageId: 'ami-23456789', suffix: 'Cache' },
  { ImageId: 'ami-34567890', suffix: 'App' }
];

const t = Template().add(
  instances.map(i =>
    EC2.Instance(`Instance${i.suffix}`, {
      ImageId: i.ImageId,
      InstanceType: 't2-micro'
    })
  )
);

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "InstanceWeb": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": "ami-12345678",
        "InstanceType": "t2-micro"
      }
    },
    "InstanceCache": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": "ami-23456789",
        "InstanceType": "t2-micro"
      }
    },
    "InstanceApp": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": "ami-34567890",
        "InstanceType": "t2-micro"
      }
    }
  }
}

remove

The remove() method will remove any element in the template and returns a new Template object. The method takes a single parameter, which is the logical name of the element in the template as a string:

const { EC2, Template } = require('wolkenkratzer');

const t = Template()
  .add(
    EC2.Instance('Instance', {
      ImageId: 'ami-12345678',
      InstanceType: 't2-micro'
    })
  )
  .remove('Instance');

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {}
}

The method alternatively accepts an element object (Resource, Parameter, Output, etc) as the argument:

const { EC2, Template } = require('wolkenkratzer');

const instance = EC2.Instance('Instance', {
  ImageId: 'ami-12345678',
  InstanceType: 't2-micro'
});

const t = Template()
  .add(instance)
  .remove('Instance');

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {}
}

removeDescription

You can call the removeDescription() method to remove a template description that was previously added. The method takes no arguments:

const { Description, EC2, Template } = require('wolkenkratzer');

const t = Template()
  .add(
    EC2.Instance('Instance', {
      ImageId: 'ami-12345678',
      InstanceType: 't2-micro'
    })
  )
  .add(Description('This is a sample template'))
  .removeDescription();

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "Instance": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": "ami-12345678",
        "InstanceType": "t2-micro"
      }
    }
  }
}

build

A Wolkenkratzer Template object contains some metadata to make certain internal things possible, but are not valid CloudFormation. Use the build() method to return a Javascript object that is a valid CloudFormation template when stringified:

const { Description, EC2, Template } = require('wolkenkratzer');

const t = Template()
  .add(
    EC2.Instance('Instance', {
      ImageId: 'ami-12345678',
      InstanceType: 't2-micro'
    })
  )
  .add(Description('This is a sample template'))
  .removeDescription();

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "Instance": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": "ami-12345678",
        "InstanceType": "t2-micro"
      }
    }
  }
}

merge

The merge() method takes a Template object as a parameter and adds the contents to the existing template object:

const { EC2, S3, Template } = require('wolkenkratzer');

const t0 = Template().add(
  EC2.Instance('Instance', {
    ImageId: 'ami-12345678',
    InstanceType: 't2-micro'
  })
);

const t1 = Template()
  .add(S3.Bucket('Bucket'))
  .merge(t0);

console.log(JSON.stringify(t1.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "Bucket": {
      "Type": "AWS::S3::Bucket"
    },
    "Instance": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": "ami-12345678",
        "InstanceType": "t2-micro"
      }
    }
  }
}

import

The import() method takes an existing template in as a parameter and adds its contents to the Template object:

const { Template } = require('wolkenkratzer');
const { readFile } = require('fs');

readFile('./s3.json', (err, data) => {
  const templ = JSON.parse(data.toString());
  const t = Template().import(templ);
  console.log(JSON.stringify(t.build(), null, 2));
});

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "Bucket": {
      "Type": "AWS::S3::Bucket"
    }
  },
  "Outputs": {
    "Bucket": {
      "Description": "The Bucket S3 Bucket",
      "Value": {
        "Ref": "Bucket"
      },
      "Export": {
        "Name": {
          "Fn::Sub": "${AWS::StackName}-S3-Bucket-Bucket"
        }
      }
    }
  }
}

Any cloudformation template should be importable, but if you run into any issues please open up an issue and report the problem.

has

The has() method checks whether something exists in a Template. The method returns a boolean value, true if the Template contains the item, false if it does not. This is one of the few Template API methods that does not return a Template object.

const { EC2, Template } = require('wolkenkratzer');

const t = Template().add(
  EC2.Instance('Instance', {
    ImageId: 'ami-12345678',
    InstanceType: 't2-micro'
  })
);

console.log(t.has('Instance'));

true

parameterize

The parameterize() method is a convenience method that converts a Resource attribute into a Parameter, and sets the attribute to a Ref of the parameter:

const { EC2, Template } = require('wolkenkratzer');

const t = Template()
  .add(
    EC2.Instance('MyInstance', {
      ImageId: 'ami-12345678',
      InstanceType: 't2-micro'
    })
  )
  .parameterize('MyInstance.InstanceType');

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "MyInstance": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": "ami-12345678",
        "InstanceType": {
          "Ref": "MyInstanceInstanceType"
        }
      }
    }
  },
  "Parameters": {
    "MyInstanceInstanceType": {
      "Type": "String"
    }
  }
}

putOut

Similar to parameterize(), the putOut() method takes a Resource attribute as a parameter and turns it into an Output:

const { EC2, Template } = require('wolkenkratzer');

const t = Template()
  .add(
    EC2.Instance('MyInstance', {
      ImageId: 'ami-12345678',
      InstanceType: 't2-micro'
    })
  )
  .putOut('MyInstance.InstanceType');

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "MyInstance": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": "ami-12345678",
        "InstanceType": "t2-micro"
      }
    }
  },
  "Outputs": {
    "MyInstanceInstanceType": {
      "Description": "The InstanceType of the MyInstance EC2 Instance",
      "Export": {
        "Name": {
          "Fn::Sub": "${AWS::StackName}-EC2-Instance-MyInstance-InstanceType"
        }
      },
      "Value": {
        "Ref": "MyInstance"
      }
    }
  }
}

set

The set() method allows you to set a new value to an attribute in an element in the Template (Resource, Parameter, etc). The first parameter is a string with the name of the element and the attribute name, separated by a period. The second parameter is the new value of the attribute. The method returns a new Template object.

const { EC2, Template } = require('wolkenkratzer');

const t = Template()
  .add(
    EC2.Instance('Instance', {
      ImageId: 'ami-12345678',
      InstanceType: 't2-micro'
    })
  )
  .set('Instance.InstanceType', 't2-nano');

console.log(JSON.stringify(t.build(), null, 2));

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "Instance": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": "ami-12345678",
        "InstanceType": "t2-nano"
      }
    }
  }
}

json

The json() method returns the template as a CloudFormation-compatible JSON-formatted string:

const { EC2, Template } = require('wolkenkratzer');

const t = Template().add(
  EC2.Instance('Instance', {
    ImageId: 'ami-12345678',
    InstanceType: 't2-micro'
  })
);
console.log(t.json());

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "Instance": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": "ami-12345678",
        "InstanceType": "t2-micro"
      }
    }
  }
}

yaml

The yaml() method returns the template as a CloudFormation-compatible YAML-formatted string:

const { EC2, Template } = require('wolkenkratzer');

const t = Template().add(
  EC2.Instance('Instance', {
    ImageId: 'ami-12345678',
    InstanceType: 't2-micro'
  })
);

console.log(t.yaml());

AWSTemplateFormatVersion: '2010-09-09'
Resources:
  Instance:
    Type: 'AWS::EC2::Instance'
    Properties:
      ImageId: ami-12345678
      InstanceType: t2-micro

Examples

Please see the examples/ folder for real examples on how to use the library. All of the examples are unit tested and verified to run, although not all of them have been tested against AWS CloudFormation recently. If you run into a problem with an example, please open up an issue.

API Documentation

Index

Functions

• Condition
• CreationPolicy
• CustomResource
• DeletionPolicy
• DependsOn
• Description
• FnAnd
• FnBase64
• FnEquals
• FnFindInMap
• FnGetAZs
• FnGetAtt
• FnIf
• FnImportValue
• FnJoin
• FnNot
• FnOr
• FnSelect
• FnSplit
• FnSub
• Mapping
• Output
• Parameter
• Ref
• Resource
• ResourceMetadata
• Service
• Template
• UpdatePolicy
• buildInlineLambda
• buildInlineLambdaTemplate
• buildIntrinsic
• buildLambda
• buildLambdaTemplate
• buildZipLambda
• buildZipLambdaTemplate
• getAMIMap
• getInstanceTypeList
• getInstanceTypeMap
• getInstanceTypeNameList
• getRegions

Object literals

• ApiGateway
• ApplicationAutoScaling
• Athena
• AutoScaling
• Batch
• CertificateManager
• Cloud9
• CloudFormation
• CloudFront
• CloudWatch
• CodeBuild
• CodeCommit
• CodeDeploy
• CodePipeline
• Cognito
• Config
• DAX
• DMS
• DataPipeline
• DirectoryService
• DynamoDB
• EFS
• EMR
• ElastiCache
• ElasticBeanstalk
• ElasticLoadBalancing
• ElasticLoadBalancingV2
• Elasticsearch
• Events
• GameLift
• Glue
• GuardDuty
• Inspector
• IoT
• KMS
• KinesisAnalytics
• KinesisFirehose
• Logs
• OpsWorks
• Pseudo
• RDS
• Redshift
• SDB
• SSM
• ServiceDiscovery
• StepFunctions
• Transform
• WAF
• WAFRegional
• WorkSpaces

Functions

Condition

► Condition(name: string, conditionFn: IFnAnd⎮IFnEquals⎮IFnIf⎮IFnNot⎮IFnOr): ICondition

Defined in elements/condition.ts:10

Create a Condition object

Parameters:

Returns: ICondition

CreationPolicy

► CreationPolicy(resource: string, content: any): ICreationPolicy

Defined in attributes/creationpolicy.ts:3

Parameters:

Returns: ICreationPolicy

CustomResource

► CustomResource(name: string, properties: any, options: any): IResource

Defined in elements/resource.ts:33

Parameters:

Returns: IResource

DeletionPolicy

► DeletionPolicy(resource: string, content: "Delete"⎮"Retain"⎮"Snapshot"): IDeletionPolicy

Defined in attributes/deletionpolicy.ts:3

Parameters:

Returns: IDeletionPolicy

DependsOn

► DependsOn(resource: string, content: string⎮string[]): IDependsOn

Defined in attributes/dependson.ts:3

Parameters:

Returns: IDependsOn

Description

► Description(content: string): IDescription

Defined in elements/description.ts:7

Set the Description of a template

Parameters:

Returns: IDescription

FnAnd

► FnAnd(one: Conditional, two: Conditional): IFnAnd

Defined in intrinsic.ts:28

Returns an Fn::And object

Parameters:

Returns: IFnAnd

FnBase64

► FnBase64(input: string): IFnBase64

Defined in intrinsic.ts:130

Returns an Fn::Base64 object

Parameters:

Returns: IFnBase64

FnEquals

► FnEquals(one: Conditional, two: Conditional): IFnEquals

Defined in intrinsic.ts:114

Returns an Fn::Equals object

Parameters:

Returns: IFnEquals

FnFindInMap

► FnFindInMap(mapName: string, topLevelKey: string, secondLevelKey: string): IFnFindInMap

Defined in intrinsic.ts:140

Returns an Fn::FindInMap object

Parameters:

Returns: IFnFindInMap

FnGetAZs

► FnGetAZs(region: string⎮IRef): IFnGetAZs

Defined in intrinsic.ts:155

Returns an Fn::GetAZs object

Parameters:

Returns: IFnGetAZs

FnGetAtt

► FnGetAtt(target: IResource⎮string, attr: string): IFnGetAtt

Defined in intrinsic.ts:85

Returns an Fn::GetAtt object that references another element in the template

Parameters:

Returns: IFnGetAtt

FnIf

► FnIf(items: Array.<string⎮IIntrinsic>): IFnIf

Defined in intrinsic.ts:64

Returns an Fn::If object

Parameters:

Returns: IFnIf

FnImportValue

► FnImportValue(value: string⎮IFnBase64⎮IFnFindInMap⎮IFnIf⎮IFnJoin⎮IFnSelect⎮IFnSplit⎮IFnSub⎮IRef): IFnImportValue

Defined in intrinsic.ts:216

Returns an Fn::ImportValue object

Parameters:

Returns: IFnImportValue

FnJoin

► FnJoin(delimiter: string, values: Array.<string⎮IFnGetAtt⎮IRef>⎮IFnGetAtt): IFnJoin

Defined in intrinsic.ts:96

Returns an Fn::Join object

Parameters:

Returns: IFnJoin

FnNot

► FnNot(items: Array.<string⎮IIntrinsic>): IFnNot

Defined in intrinsic.ts:56

Returns an Fn::Not object

Parameters:

Returns: IFnNot

FnOr

► FnOr(items: Array.<string⎮IIntrinsic>): IFnOr

Defined in intrinsic.ts:48

Returns an Fn::Or object

Parameters:

Returns: IFnOr

FnSelect

► FnSelect(index: string⎮number, list: Array.<string⎮IFnFindInMap⎮IFnGetAtt⎮IFnGetAZs⎮IFnIf⎮IFnSplit⎮IRef>): IFnSelect

Defined in intrinsic.ts:167

Returns an Fn::Select object

Parameters:

Returns: IFnSelect

FnSplit

► FnSplit(delimiter: string, value: string): IFnSplit

Defined in intrinsic.ts:237

Returns an Fn::Split object

Parameters:

Returns: IFnSplit

FnSub

► FnSub(input: string): IFnSub

Defined in intrinsic.ts:122

Returns an Fn::Sub object

Parameters:

Returns: IFnSub

Mapping

► Mapping(name: string, subName: string, body: object): IMapping

Defined in elements/mapping.ts:9

Create a Mapping object

Parameters:

Returns: IMapping

Output

► Output(name: string, properties: IOutputProperties): IOutput

Defined in elements/output.ts:10

Creatr an Output object

Parameters:

Returns: IOutput

Parameter

► Parameter(name: string, properties: IParameterProperties): IParameter

Defined in elements/parameter.ts:8

Create a Parameter object

Parameters:

Returns: IParameter

Ref

► Ref(target: IResource⎮IParameter⎮string): IRef

Defined in intrinsic.ts:72

Returns a Ref object that references another element in the template

Parameters:

Returns: IRef

Resource

► Resource(name: string, properties: any, options: any): IResource

Defined in elements/resource.ts:9

Create a Resource object

Parameters:

Returns: IResource

ResourceMetadata

► ResourceMetadata(resource: string, content: any): IResourceMetadata

Defined in attributes/metadata.ts:3

Parameters:

Returns: IResourceMetadata

Service

► Service(json: any): IService

Defined in service.ts:8

Return a Service object to create Resources and Attributes

Parameters:

Returns: IService

Template

► Template(): ITemplate

Defined in template/index.ts:35

Returns a new Template object. member: Template

Returns: ITemplate ITemplate

UpdatePolicy

► UpdatePolicy(resource: string, content: any): IUpdatePolicy

Defined in attributes/updatepolicy.ts:3

Parameters:

Returns: IUpdatePolicy

buildInlineLambda

► buildInlineLambda(__namedParameters: object): Promise.<IResource>

Defined in macros/lambda.macro.ts:159

Create an inline Lambda function

Parameters:

Returns: Promise.<IResource>

buildInlineLambdaTemplate

► buildInlineLambdaTemplate(__namedParameters: object): Promise.<ITemplate>

Defined in macros/lambda.macro.ts:138

Create an inline Lambda function from a folder or source file

Parameters:

Returns: Promise.<ITemplate>

buildIntrinsic

► buildIntrinsic(input: any): any

Defined in intrinsic.ts:183

Parameters:

Returns: any

buildLambda

► buildLambda(__namedParameters: object): Promise.<Object>

Defined in macros/lambda.macro.ts:302

Create a Lambda function from a folder or source file

Parameters:

Returns: Promise.<Object>

buildLambdaTemplate

► buildLambdaTemplate(__namedParameters: object): Promise.<Object>

Defined in macros/lambda.macro.ts:459

Create a Lambda function from a folder or source file

Parameters:

Returns: Promise.<Object>

buildZipLambda

► buildZipLambda(__namedParameters: object): Promise.<IZipLambdaResult>

Defined in macros/lambda.macro.ts:278

Create a Lambda function from a folder or source file

Parameters:

Returns: Promise.<IZipLambdaResult>

buildZipLambdaTemplate

► buildZipLambdaTemplate(__namedParameters: object): Promise.<IZipLambdaTemplateResult>

Defined in macros/lambda.macro.ts:410

Create a Lambda function from a folder or source file

Parameters:

Returns: Promise.<IZipLambdaTemplateResult>

getAMIMap

► getAMIMap(filters: any, regions: any, aws: any): Bluebird.<any>

Defined in macros/ec2meta.macro.ts:78

Returns an AMI Map that can be added to a Mapping. memberof: module:Macro

Parameters:

Returns: Bluebird.<any>

getInstanceTypeList

► getInstanceTypeList(): any

Defined in macros/ec2meta.macro.ts:15

Returns an array of all instance types and details. memberof: module:Macro

Returns: any

getInstanceTypeMap

► getInstanceTypeMap(): any

Defined in macros/ec2meta.macro.ts:37

Returns a map of all instance types and details. memberof: module:Macro

Returns: any

getInstanceTypeNameList

► getInstanceTypeNameList(): string[]

Defined in macros/ec2meta.macro.ts:24

Returns an array of just the instance type names available in AWS. memberof: module:Macro

Returns: string[]

getRegions

► getRegions(): string[]

Defined in macros/ec2meta.macro.ts:50

Returns an array of the names of all regions in AWS. memberof: module:Macro

Returns: string[]

Object literal: ApiGateway

Models

** Models**: object

Defined in spec/spec.ts:702

ApiStage

** ApiStage**: object

Defined in spec/spec.ts:1115

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html"

Defined in spec/spec.ts:1116

Name

● Name: string = "AWS::ApiGateway::UsagePlan.ApiStage"

Defined in spec/spec.ts:1131

Properties

** Properties**: object

Defined in spec/spec.ts:1117

ApiId

** ApiId**: object

Defined in spec/spec.ts:1118

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-apiid"

Defined in spec/spec.ts:1119

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:1120

Required

● Required: boolean = false

Defined in spec/spec.ts:1121

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:1122

Stage

** Stage**: object

Defined in spec/spec.ts:1124

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-stage"

Defined in spec/spec.ts:1125

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:1126

Required

● Required: boolean = false

Defined in spec/spec.ts:1127

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:1128

EndpointConfiguration

** EndpointConfiguration**: object

Defined in spec/spec.ts:923

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html"

Defined in spec/spec.ts:924

Name

● Name: string = "AWS::ApiGateway::RestApi.EndpointConfiguration"

Defined in spec/spec.ts:935

Properties

** Properties**: object

Defined in spec/spec.ts:925

Types

** Types**: object

Defined in spec/spec.ts:926

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-types"

Defined in spec/spec.ts:927

DuplicatesAllowed

● DuplicatesAllowed: boolean = false

Defined in spec/spec.ts:928

PrimitiveItemType

● PrimitiveItemType: string = "String"

Defined in spec/spec.ts:929

Required

● Required: boolean = false

Defined in spec/spec.ts:930

Type

● Type: string = "List"

Defined in spec/spec.ts:931

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:932

Integration

** Integration**: object

Defined in spec/spec.ts:937

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html"

Defined in spec/spec.ts:938

Name

● Name: string = "AWS::ApiGateway::Method.Integration"

Defined in spec/spec.ts:1015

Properties

** Properties**: object

Defined in spec/spec.ts:939

CacheKeyParameters

** CacheKeyParameters**: object

Defined in spec/spec.ts:940

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-cachekeyparameters"

Defined in spec/spec.ts:941

DuplicatesAllowed

● DuplicatesAllowed: boolean = false

Defined in spec/spec.ts:942

PrimitiveItemType

● PrimitiveItemType: string = "String"

Defined in spec/spec.ts:943

Required

● Required: boolean = false

Defined in spec/spec.ts:944

Type

● Type: string = "List"

Defined in spec/spec.ts:945

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:946

CacheNamespace

** CacheNamespace**: object

Defined in spec/spec.ts:948

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-cachenamespace"

Defined in spec/spec.ts:949

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:950

Required

● Required: boolean = false

Defined in spec/spec.ts:951

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:952

ContentHandling

** ContentHandling**: object

Defined in spec/spec.ts:954

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-contenthandling"

Defined in spec/spec.ts:955

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:956

Required

● Required: boolean = false

Defined in spec/spec.ts:957

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:958

Credentials

** Credentials**: object

Defined in spec/spec.ts:960

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-credentials"

Defined in spec/spec.ts:961

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:962

Required

● Required: boolean = false

Defined in spec/spec.ts:963

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:964

IntegrationHttpMethod

** IntegrationHttpMethod**: object

Defined in spec/spec.ts:966

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-integrationhttpmethod"

Defined in spec/spec.ts:967

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:968

Required

● Required: boolean = false

Defined in spec/spec.ts:969

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:970

IntegrationResponses

** IntegrationResponses**: object

Defined in spec/spec.ts:972

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-integrationresponses"

Defined in spec/spec.ts:973

DuplicatesAllowed

● DuplicatesAllowed: boolean = false

Defined in spec/spec.ts:974

ItemType

● ItemType: string = "IntegrationResponse"

Defined in spec/spec.ts:975

Required

● Required: boolean = false

Defined in spec/spec.ts:976

Type

● Type: string = "List"

Defined in spec/spec.ts:977

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:978

PassthroughBehavior

** PassthroughBehavior**: object

Defined in spec/spec.ts:980

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-passthroughbehavior"

Defined in spec/spec.ts:981

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:982

Required

● Required: boolean = false

Defined in spec/spec.ts:983

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:984

RequestParameters

** RequestParameters**: object

Defined in spec/spec.ts:986

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-requestparameters"

Defined in spec/spec.ts:987

DuplicatesAllowed

● DuplicatesAllowed: boolean = false

Defined in spec/spec.ts:988

PrimitiveItemType

● PrimitiveItemType: string = "String"

Defined in spec/spec.ts:989

Required

● Required: boolean = false

Defined in spec/spec.ts:990

Type

● Type: string = "Map"

Defined in spec/spec.ts:991

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:992

RequestTemplates

** RequestTemplates**: object

Defined in spec/spec.ts:994

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-requesttemplates"

Defined in spec/spec.ts:995

DuplicatesAllowed

● DuplicatesAllowed: boolean = false

Defined in spec/spec.ts:996

PrimitiveItemType

● PrimitiveItemType: string = "String"

Defined in spec/spec.ts:997

Required

● Required: boolean = false

Defined in spec/spec.ts:998

Type

● Type: string = "Map"

Defined in spec/spec.ts:999

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:1000

Type

** Type**: object

Defined in spec/spec.ts:1002

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-type"

Defined in spec/spec.ts:1003

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:1004

Required

● Required: boolean = false

Defined in spec/spec.ts:1005

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:1006

Uri

** Uri**: object

Defined in spec/spec.ts:1008

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-uri"

Defined in spec/spec.ts:1009

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:1010

Required

● Required: boolean = false

Defined in spec/spec.ts:1011

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:1012

IntegrationResponse

** IntegrationResponse**: object

Defined in spec/spec.ts:1017

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html"

Defined in spec/spec.ts:1018

Name

● Name: string = "AWS::ApiGateway::Method.IntegrationResponse"

Defined in spec/spec.ts:1055

Properties

** Properties**: object

Defined in spec/spec.ts:1019

ContentHandling

** ContentHandling**: object

Defined in spec/spec.ts:1020

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integrationresponse-contenthandling"

Defined in spec/spec.ts:1021

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:1022

Required

● Required: boolean = false

Defined in spec/spec.ts:1023

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:1024

ResponseParameters

** ResponseParameters**: object

Defined in spec/spec.ts:1026

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-responseparameters"

Defined in spec/spec.ts:1027

DuplicatesAllowed

● DuplicatesAllowed: boolean = false

Defined in spec/spec.ts:1028

PrimitiveItemType

● PrimitiveItemType: string = "String"

Defined in spec/spec.ts:1029

Required

● Required: boolean = false

Defined in spec/spec.ts:1030

Type

● Type: string = "Map"

Defined in spec/spec.ts:1031

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:1032

ResponseTemplates

** ResponseTemplates**: object

Defined in spec/spec.ts:1034

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-responsetemplates"

Defined in spec/spec.ts:1035

DuplicatesAllowed

● DuplicatesAllowed: boolean = false

Defined in spec/spec.ts:1036

PrimitiveItemType

● PrimitiveItemType: string = "String"

Defined in spec/spec.ts:1037

Required

● Required: boolean = false

Defined in spec/spec.ts:1038

Type

● Type: string = "Map"

Defined in spec/spec.ts:1039

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:1040

SelectionPattern

** SelectionPattern**: object

Defined in spec/spec.ts:1042

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-selectionpattern"

Defined in spec/spec.ts:1043

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:1044

Required

● Required: boolean = false

Defined in spec/spec.ts:1045

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:1046

StatusCode

** StatusCode**: object

Defined in spec/spec.ts:1048

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-statuscode"

Defined in spec/spec.ts:1049

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:1050

Required

● Required: boolean = true

Defined in spec/spec.ts:1051

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:1052

Location

** Location**: object

Defined in spec/spec.ts:887

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html"

Defined in spec/spec.ts:888

Name

● Name: string = "AWS::ApiGateway::DocumentationPart.Location"

Defined in spec/spec.ts:921

Properties

** Properties**: object

Defined in spec/spec.ts:889

Method

** Method**: object

Defined in spec/spec.ts:890

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-method"

Defined in spec/spec.ts:891

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:892

Required

● Required: boolean = false

Defined in spec/spec.ts:893

UpdateType

● UpdateType: string = "Immutable"

Defined in spec/spec.ts:894

Name

** Name**: object

Defined in spec/spec.ts:896

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-name"

Defined in spec/spec.ts:897

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:898

Required

● Required: boolean = false

Defined in spec/spec.ts:899

UpdateType

● UpdateType: string = "Immutable"

Defined in spec/spec.ts:900

Path

** Path**: object

Defined in spec/spec.ts:902

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-path"

Defined in spec/spec.ts:903

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:904

Required

● Required: boolean = false

Defined in spec/spec.ts:905

UpdateType

● UpdateType: string = "Immutable"

Defined in spec/spec.ts:906

StatusCode

** StatusCode**: object

Defined in spec/spec.ts:908

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-statuscode"

Defined in spec/spec.ts:909

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:910

Required

● Required: boolean = false

Defined in spec/spec.ts:911

UpdateType

● UpdateType: string = "Immutable"

Defined in spec/spec.ts:912

Type

** Type**: object

Defined in spec/spec.ts:914

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-type"

Defined in spec/spec.ts:915

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:916

Required

● Required: boolean = false

Defined in spec/spec.ts:917

UpdateType

● UpdateType: string = "Immutable"

Defined in spec/spec.ts:918

MethodResponse

** MethodResponse**: object

Defined in spec/spec.ts:1057

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html"

Defined in spec/spec.ts:1058

Name

● Name: string = "AWS::ApiGateway::Method.MethodResponse"

Defined in spec/spec.ts:1083

Properties

** Properties**: object

Defined in spec/spec.ts:1059

ResponseModels

** ResponseModels**: object

Defined in spec/spec.ts:1060

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responsemodels"

Defined in spec/spec.ts:1061

DuplicatesAllowed

● DuplicatesAllowed: boolean = false

Defined in spec/spec.ts:1062

PrimitiveItemType

● PrimitiveItemType: string = "String"

Defined in spec/spec.ts:1063

Required

● Required: boolean = false

Defined in spec/spec.ts:1064

Type

● Type: string = "Map"

Defined in spec/spec.ts:1065

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:1066

ResponseParameters

** ResponseParameters**: object

Defined in spec/spec.ts:1068

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responseparameters"

Defined in spec/spec.ts:1069

DuplicatesAllowed

● DuplicatesAllowed: boolean = false

Defined in spec/spec.ts:1070

PrimitiveItemType

● PrimitiveItemType: string = "Boolean"

Defined in spec/spec.ts:1071

Required

● Required: boolean = false

Defined in spec/spec.ts:1072

Type

● Type: string = "Map"

Defined in spec/spec.ts:1073

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:1074

StatusCode

** StatusCode**: object

Defined in spec/spec.ts:1076

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-statuscode"

Defined in spec/spec.ts:1077

PrimitiveType

● PrimitiveType: string = "String"

Defined in spec/spec.ts:1078

Required

● Required: boolean = true

Defined in spec/spec.ts:1079

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:1080

MethodSetting

** MethodSetting**: object

Defined in spec/spec.ts:721

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html"

Defined in spec/spec.ts:722

Name

● Name: string = "AWS::ApiGateway::Stage.MethodSetting"

Defined in spec/spec.ts:785

Properties

** Properties**: object

Defined in spec/spec.ts:723

CacheDataEncrypted

** CacheDataEncrypted**: object

Defined in spec/spec.ts:724

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachedataencrypted"

Defined in spec/spec.ts:725

PrimitiveType

● PrimitiveType: string = "Boolean"

Defined in spec/spec.ts:726

Required

● Required: boolean = false

Defined in spec/spec.ts:727

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:728

CacheTtlInSeconds

** CacheTtlInSeconds**: object

Defined in spec/spec.ts:730

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachettlinseconds"

Defined in spec/spec.ts:731

PrimitiveType

● PrimitiveType: string = "Integer"

Defined in spec/spec.ts:732

Required

● Required: boolean = false

Defined in spec/spec.ts:733

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:734

CachingEnabled

** CachingEnabled**: object

Defined in spec/spec.ts:736

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachingenabled"

Defined in spec/spec.ts:737

PrimitiveType

● PrimitiveType: string = "Boolean"

Defined in spec/spec.ts:738

Required

● Required: boolean = false

Defined in spec/spec.ts:739

UpdateType

● UpdateType: string = "Mutable"

Defined in spec/spec.ts:740

DataTraceEnabled

** DataTraceEnabled**: object

Defined in spec/spec.ts:742

Documentation

● Documentation: string = "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-datatraceenabled"