Module Cfgen.BaseConstructs

Organisation

Hierarchy

The modules are organised into three tiers, corresponding to the three-level naming for CloudFormation resources:

• Namespace
• Service
• Resource

(which is the same as the Namespace::Service::Resource breakdown in CloudFormation)

• Namespace is the top-level namespace for the resources (AWS or Alexa - most resources are in AWS)
• Service is the AWS service that provides the resources, e.g. IAM, CloudWatch, Lambda, EC2, etc
• Resource is the specific resource type in that service, e.g. Function, EventSourceMapping, Permission (in AWS::Lambda)

Resource Modules

In each resource module, you will find (in order):

• Property Specifications - record types corresponding to some of the properties of the resource
• Resource Specification - a record type describing the top-level properties of the resource
• Attribute Specification - a record type describing the attributes of a resource
• Creation Functions - helper functions, beginning with make_* to create the property and resource types
• Serialisation Functions - yojson_of_* functions used to serialise the resource properties to JSON

Usage

The reference guide provides more details on how to use these modules to construct CloudFormation resources in your stack.