Packages

•  package root

  Definition Classes

  root

•  package com

  Definition Classes

  root

•  package monsanto

  Definition Classes

  com

•  package arch

  Definition Classes

  monsanto

•  package cloudformation

  Definition Classes

  arch

•  package model

  A DSL to create consistent, type-safe AWS CloudFormation templates.

  A DSL to create consistent, type-safe AWS CloudFormation templates.

  The low-level DSL closely adheres to the objects and parameters in the CloudFormation template JSON specification. If you intend to use this DSL to create CloudFormation templates, it would behoove you to familiarize yourself with the CloudFormation documentation.

  In addition to the low-level, DSL, there are several higher-order builders and convenience methods. See com.monsanto.arch.cloudformation.model.simple.Builders for more information on these helper methods.

  For a discussion of the features and approach of this library, read our blog post.

  Sample usage:

  import com.monsanto.arch.cloudformation.model._
  import com.monsanto.arch.cloudformation.model.resource._
  import com.monsanto.arch.cloudformation.model.simple.Builders._
  
  object SimpleVPC extends VPCWriter {
    val ownerParameter = StringParameter(
      name = "Owner",
      Description = Some("Individual responsible for this template"),
      MinLength = Some(StringBackedInt(1)),
      MaxLength = Some(StringBackedInt(64)),
      AllowedPattern = Some("[-_ a-zA-Z0-9]*"),
      ConstraintDescription = Some("Can contain only alphanumeric characters, spaces, dashes and underscores.")
    )
    val keyNameParameter = `AWS::EC2::KeyPair::KeyName_Parameter`(
      name = "KeyName",
      Description = Some("Name of an existing EC2 KeyPair to enable SSH access to the instances"),
      ConstraintDescription = Some("Value must be a valid AWS key pair name in your account.")
    )
    val allowSSHFromParameter = CidrBlockParameter(
      name = "AllowSSHFrom",
      Description = Some("The net block (CIDR) that SSH is available to.")
    )
    val simpleParameters = Seq(
      ownerParameter,
      keyNameParameter,
      allowSSHFromParameter
    )
  
    val simpleConditions = Seq(
      Condition(
        name = "ShouldDisablePassword",
        function = `Fn::Equals`(
          a = ParameterRef(ownerParameter),
          b = StringToken("rms")
        )
      )
    )
  
    val amazonLinuxAMIMapping = Mapping[AMIId](
      "AmazonLinuxAMI",
      Map(
        "us-east-1"      -> Map("AMI" -> AMIId("ami-1ecae776")),
        "us-west-1"      -> Map("AMI" -> AMIId("ami-d114f295")),
        "us-west-2"      -> Map("AMI" -> AMIId("ami-e7527ed7")),
        "eu-west-1"      -> Map("AMI" -> AMIId("ami-a10897d6")),
        "ap-southeast-1" -> Map("AMI" -> AMIId("ami-68d8e93a")),
        "ap-southeast-2" -> Map("AMI" -> AMIId("ami-fd9cecc7")),
        "ap-northeast-1" -> Map("AMI" -> AMIId("ami-cbf90ecb"))
      )
    )
    val simpleMappings = Seq(amazonLinuxAMIMapping)
  
    val simpleResourceAndOutputs = withVpc(CidrBlock(10, 0, 0, 0, 16)) { implicit vpc =>
      val (internetGatewayResource, gatewayToInternetResource) = withInternetGateway
      val publicRouteTable = withRouteTable("Public", 1)
      val publicRouteTableRoute = publicRouteTable.withRoute(
        visibility = "Public",
        routeTableOrdinal = 1,
        routeOrdinal = 1,
        connectionBobber = InternetGatewayRoute(ResourceRef(internetGatewayResource))
      )
      val gatewayStuff = Template.fromResource(internetGatewayResource) ++
        gatewayToInternetResource ++
        publicRouteTable ++
        publicRouteTableRoute
      val withinAZ = withAZ("us-east-1a") { implicit az =>
        withSubnet("PubSubnet1", CidrBlock(10, 0, 0, 1, 24)) { implicit pubSubnet =>
          val bastionName = "bastion"
          val bastion = ec2(
            name = bastionName,
            InstanceType = "t2.micro",
            KeyName = ParameterRef(keyNameParameter),
            ImageId = `Fn::FindInMap`[AMIId](MappingRef(amazonLinuxAMIMapping), `AWS::Region`, "AMI"),
            SecurityGroupIds = Seq(),
            Tags = AmazonTag.fromName(bastionName),
            UserData = Some(`Fn::Base64`(
              `Fn::Join`("",
                Seq[Token[String]](
                  "#!/bin/bash -v\n",
                  "yum update -y --security\n",
                  "# EOF\n"
                )
              )
            ))
          )
          val sshToBastion = ParameterRef(allowSSHFromParameter) ->- 22 ->- bastion
          Template.fromSecurityGroupRoutable(bastion) ++
            bastion.map(_.withEIP("BastionEIP").andOutput("BastionEIP", "Bastion Host EIP")) ++
            Template.collapse(sshToBastion)
        }
      }
      gatewayStuff ++
        withinAZ
    }
    val simpleTemplate = simpleResourceAndOutputs ++
      Template(
        AWSTemplateFormatVersion = Some("2010-09-09"),
        Description = Some("Simple template"),
        Parameters = Some(simpleParameters),
        Conditions = Some(simpleConditions),
        Mappings = Some(simpleMappings),
        Resources = Seq.empty,
        Outputs = None
      )
    writeStaxModule("vpc-simple.json", simpleTemplate)
  }
  SimpleVPC

  The above code utilizes the DSL to create a simple AWS VPC utilizing a single Availability Zone having a single public subnet and a single "bastion" instance. The template output is the IP address of the EIP it creates. It also shows examples of creating and using Parameters and Mappings. A Condition is created but not used.

  Definition Classes

  cloudformation

•  package resource

  Definition Classes

  model

•  package simple

  Definition Classes

  model

• AMIIdParameter
• AWS::AccountId
• AWS::EC2::KeyPair::KeyName_Parameter
• AWS::EC2::SecurityGroup_Parameter
• AWS::EC2::Subnet_Parameter_List
• AWS::EC2::VPC_Parameter
• AWS::NoValue
• AWS::NotificationARNs
• AWS::RDS::DBInstance::Engine_Parameter
• AWS::RDS::DBSubnetGroup_Parameter
• AWS::Region
• AWS::StackId
• AWS::StackName
• AmazonFunctionCall
• AnyToken
• AwsStringInterpolation
• AwsStringInterpolator
• BooleanParameter
• BooleanToken
• CidrBlockListParameter
• CidrBlockParameter
• Condition
• ConditionFnRef
• ConditionFunctionNestable
• ConditionRef
• EnumFormat
• Fn::And
• Fn::Base64
• Fn::Equals
• Fn::FindInMap
• Fn::GetAZs
• Fn::GetArtifactAtt
• Fn::GetAtt
• Fn::GetParam
• Fn::If
• Fn::ImportValue
• Fn::Join
• Fn::Not
• Fn::Or
• Fn::Select
• Fn::Split
• Fn::Sub
• FunctionCallSeqToken
• FunctionCallToken
• HasTemplate
• If
• InputParameter
• IntToken
• JsonWritable
• Mapping
• MappingRef
• NestableAmazonFunctionCall
• NumberParameter
• Output
• Parameter
• ParameterRef
• PseudoParameterRef
• ResourceRef
• StringBackedInt
• StringListParameter
• StringParameter
• StringToken
• Template
• TemplateBase
• Token
• UNSAFEFunctionCallToken
• UNSAFEToken
• VPCWriter

com.monsanto.arch.cloudformation.model

BooleanParameter 

Companion object BooleanParameter