wolkenkratzer

v0.12.1

Published

2 years ago

Library for generating CloudFormation templates

Downloads

155

0High
0Medium
0Low

arminhammer

CloudFormation AWS Template Cloud aws-sdk ecs

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.

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.

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.

When adding resources to the template, you can optionally have an Output block and (string) Parameters created automatically in one call:

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

let t = Template().add(S3.Bucket('Bucket'), {
  Output: true,
  Parameters: ['BucketName'],
});

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

Result:

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "Bucket": {
      "Type": "AWS::S3::Bucket",
      "Properties": {
        "BucketName": { "Ref": "BucketS3BucketParam" }
      }
    }
  },
  "Parameters": {
    "BucketS3BucketParam": {
      "Type": "String"
    }
  },
  "Outputs": {
    "BucketS3BucketOutput": {
      "Value": {
        "Ref": "Bucket"
      },
      "Export": {
        "Name": {
          "Fn::Sub": "${AWS::StackName}-S3-Bucket-Bucket"
        }
      }
    }
  }
}

Wolkenkratzer will also do (rudimentary) template type validation, throwing an error if an incorrect value is provided.

Examples

Please see the examples/ folder for real and tested examples on how to use the library.

API

Index

Functions

Object literals

Functions

Condition

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

Defined in elements/condition.ts:10

Create a Condition object

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | name | string | - | | conditionFn | IFnAnd⎮IFnEquals⎮IFnIf⎮IFnNot⎮IFnOr | - |

Returns: ICondition

CreationPolicy

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

Defined in attributes/creationpolicy.ts:3

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | resource | string | - | | content | any | - |

Returns: ICreationPolicy

CustomResource

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

Defined in elements/resource.ts:33

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | name | string | - | | properties | any | - | | options | any | - |

Returns: IResource

DeletionPolicy

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

Defined in attributes/deletionpolicy.ts:3

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | resource | string | - | | content | "Delete"⎮"Retain"⎮"Snapshot" | - |

Returns: IDeletionPolicy

DependsOn

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

Defined in attributes/dependson.ts:3

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | resource | string | - | | content | string⎮string[] | - |

Returns: IDependsOn

Description

► Description(content: string): IDescription

Defined in elements/description.ts:7

Set the Description of a template

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | content | string | - |

Returns: IDescription

FnAnd

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

Defined in intrinsic.ts:28

Returns an Fn::And object

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | one | Conditional | - | | two | Conditional | - |

Returns: IFnAnd

FnBase64

► FnBase64(input: string): IFnBase64

Defined in intrinsic.ts:130

Returns an Fn::Base64 object

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | input | string | - |

Returns: IFnBase64

FnEquals

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

Defined in intrinsic.ts:114

Returns an Fn::Equals object

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | one | Conditional | - | | two | Conditional | - |

Returns: IFnEquals

FnFindInMap

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

Defined in intrinsic.ts:140

Returns an Fn::FindInMap object

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | mapName | string | - | | topLevelKey | string | - | | secondLevelKey | string | - |

Returns: IFnFindInMap

FnGetAZs

► FnGetAZs(region: string⎮IRef): IFnGetAZs

Defined in intrinsic.ts:155

Returns an Fn::GetAZs object

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | region | string⎮IRef | - |

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:

| Param | Type | Description | | ------ | ------ | ------ | | target | IResource⎮string | - | | attr | string | - |

Returns: IFnGetAtt

FnIf

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

Defined in intrinsic.ts:64

Returns an Fn::If object

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | items | Array.<string⎮IIntrinsic> | - |

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:

| Param | Type | Description | | ------ | ------ | ------ | | value | string⎮IFnBase64⎮IFnFindInMap⎮IFnIf⎮IFnJoin⎮IFnSelect⎮IFnSplit⎮IFnSub⎮IRef | - |

Returns: IFnImportValue

FnJoin

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

Defined in intrinsic.ts:96

Returns an Fn::Join object

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | delimiter | string | - | | values | Array.<string⎮IFnGetAtt⎮IRef>⎮IFnGetAtt | - |

Returns: IFnJoin

FnNot

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

Defined in intrinsic.ts:56

Returns an Fn::Not object

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | items | Array.<string⎮IIntrinsic> | - |

Returns: IFnNot

FnOr

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

Defined in intrinsic.ts:48

Returns an Fn::Or object

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | items | Array.<string⎮IIntrinsic> | - |

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:

| Param | Type | Description | | ------ | ------ | ------ | | index | string⎮number | - | | list | Array.<string⎮IFnFindInMap⎮IFnGetAtt⎮IFnGetAZs⎮IFnIf⎮IFnSplit⎮IRef> | - |

Returns: IFnSelect

FnSplit

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

Defined in intrinsic.ts:237

Returns an Fn::Split object

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | delimiter | string | - | | value | string | - |

Returns: IFnSplit

FnSub

► FnSub(input: string): IFnSub

Defined in intrinsic.ts:122

Returns an Fn::Sub object

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | input | string | - |

Returns: IFnSub

Mapping

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

Defined in elements/mapping.ts:9

Create a Mapping object

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | name | string | - | | subName | string | - | | body | object | - |

Returns: IMapping

Output

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

Defined in elements/output.ts:10

Creatr an Output object

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | name | string | - | | properties | IOutputProperties | - |

Returns: IOutput

Parameter

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

Defined in elements/parameter.ts:8

Create a Parameter object

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | name | string | - | | properties | IParameterProperties | - |

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:

| Param | Type | Description | | ------ | ------ | ------ | | target | IResource⎮IParameter⎮string | - |

Returns: IRef

Resource

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

Defined in elements/resource.ts:9

Create a Resource object

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | name | string | - | | properties | any | - | | options | any | - |

Returns: IResource

ResourceMetadata

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

Defined in attributes/metadata.ts:3

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | resource | string | - | | content | any | - |

Returns: IResourceMetadata

Service

► Service(json: any): IService

Defined in service.ts:8

Return a Service object to create Resources and Attributes

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | json | any | - |

Returns: IService

Template

► Template(): ITemplate

Defined in template/index.ts:36

Returns a new Template object. member: Template

Returns: ITemplate ITemplate

UpdatePolicy

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

Defined in attributes/updatepolicy.ts:3

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | resource | string | - | | content | any | - |

Returns: IUpdatePolicy

buildInlineLambda

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

Defined in macros/lambda.macro.ts:159

Create an inline Lambda function

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | __namedParameters | object | - |

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:

| Param | Type | Description | | ------ | ------ | ------ | | __namedParameters | object | - |

Returns: Promise.<ITemplate>

buildIntrinsic

► buildIntrinsic(input: any): any

Defined in intrinsic.ts:183

Parameters:

| Param | Type | Description | | ------ | ------ | ------ | | input | any | - |

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:

| Param | Type | Description | | ------ | ------ | ------ | | __namedParameters | object | - |

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:

| Param | Type | Description | | ------ | ------ | ------ | | __namedParameters | object | - |

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:

| Param | Type | Description | | ------ | ------ | ------ | | __namedParameters | object | - |

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:

| Param | Type | Description | | ------ | ------ | ------ | | __namedParameters | object | - |

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:

| Param | Type | Description | | ------ | ------ | ------ | | filters | any | - | | regions | any | - | | aws | any | - |

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

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

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

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

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

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

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

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

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

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

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

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](https://github.com/arminhammer/wolkenkratzer/b

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Welcome to Wolkenkratzer!

CloudFormation Resource support

Examples

API

Index

Functions

Object literals

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 literal: ApiGateway

Models

ApiStage

Documentation

Name

Properties

ApiId

Documentation

PrimitiveType

Required

UpdateType

Stage

Documentation

PrimitiveType

Required

UpdateType

EndpointConfiguration

Documentation

Name

Properties

Types

Documentation

DuplicatesAllowed

PrimitiveItemType

Required