Parameters

AWS CloudFormation allows customizing templates and inputting custom values to templates when creating or updating a stack. When creating a template, define a default value which will be used to provision the stack unless a different value is provided. Define the parameter value in the parameter block and use it in the resources block.

Below are several examples where we defined parameters to use inside the Spot resources, but any field is definable as a parameter.

Defining a parameter

{
  "accountId": {
    "Type": "String",
    "Default": "act-12345"
  }
}

Using a parameter value

{ "accountId": { "Ref": "accountId" } }

Common Spot Parameters

Parameter	Type	Description
shouldRoll	Boolean	Determines if the group should perform a blue-green deployment after an update to the cloud formation. Example: True
shouldUpdateTargetCapacity	Boolean	Determines if the groups target should update upon configuration updates. Example: True
shouldResumeStateful	Boolean	Determines if the group's stateful instances should resume upon capacity changes. Example: True
shouldDeleteSnapshots	Boolean	Determines if the group's EBS Volume snapshots collected from instances should be deleted once the group is deleted. Example: True
shouldDeleteVolumes	Boolean	Determines if the group's EBS Volumes collected from instances should be deleted once the group is deleted. Example: True
shouldDeleteNetworkInterfaces	Boolean	Determines if the Elastic Network Interfaces associated with the instances should be deleted once the group is deleted. Example: True Default: True
ServiceToken	String	Use the Spot Lambda. Example: Arn:aws:lambda:ca-central-1:178579023202:function:spotinst-cloudformation
accessToken	String	Spot API access token
accountId	String	Spot account ID. Example: act-12345

Request JSON Example

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Parameters": {
    "shouldRoll": {
      "Type": "String",
      "Default": "false",
      "Description": "Should roll when updating"
    },
    "shouldUpdateTargetCapacity": {
      "Type": "String",
      "Default": "true",
      "AllowedValues": ["false", "true"],
      "Description": "Should update target capacity on group update"
    }
  },
  "Resources": {
    "SpotinstElastigroup": {
      "Type": "Custom::elasticgroup",
      "Properties": {
        "updatePolicy": {
          "shouldRoll": {
            "Ref": "shouldRoll"
          },
          "rollConfig": {
            "batchSizePercentage": 50,
            "gracePeriod": 600
          },
          "shouldUpdateTargetCapacity": {
            "Ref": "shouldUpdateTargetCapacity"
          }
        },
        "group": {}
      }
    }
  }
}

Request JSON Example: Using sensitive information as parameters in multiple resources

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Parameters": {
    "ServiceToken": {
      "Type": "String",
      "Default": "arn:aws:lambda:us-west-1:178579023202:function:spotinst-cloudformation"
    },
    "accessToken": {
      "NoEcho": "true",
      "Type": "String"
    },
    "accountId": {
      "Type": "String",
      "Default": "act-12345"
    },
    "shouldRoll": {
      "Type": "String",
      "Default": "false",
      "Description": "Should roll when updating"
    },
    "shouldUpdateTargetCapacity": {
      "Type": "String",
      "Default": "true",
      "AllowedValues": ["false", "true"],
      "Description": "Should update target capacity on group update"
    }
  },
  "Resources": {
    "SpotinstElastigroup": {
      "Type": "Custom::elasticgroup",
      "Properties": {
        "ServiceToken": {
          "Ref": "ServiceToken"
        },
        "accessToken": {
          "Ref": "accessToken"
        },
        "accountId": {
          "Ref": "accountId"
        },
        "updatePolicy": {
          "shouldRoll": {
            "Ref": "shouldRoll"
          },
          "rollConfig": {
            "batchSizePercentage": 50,
            "gracePeriod": 600
          },
          "shouldUpdateTargetCapacity": {
            "Ref": "shouldUpdateTargetCapacity"
          }
        },
        "group": {}
      }
    },
    "ElastigroupSubscription": {
      "Type": "Custom::subscription",
      "Properties": {
        "ServiceToken": {
          "Ref": "ServiceToken"
        },
        "accessToken": {
          "Ref": "accessToken"
        },
        "accountId": {
          "Ref": "accountId"
        },
        "subscription": {
          "resourceId": "...",
          "protocol": "aws-sns",
          "endpoint": "arn:aws:sns:us-west-1:842422002533:my-topic",
          "eventType": "AWS_EC2_INSTANCE_TERMINATE"
        }
      }
    }
  }
}

Request JSON Example: Adding Auto Tags to Elastigroup

When you use autoTag in CloudFormation, Spot adds these tracking tags to instances provisioned as part of the custom resource:

• spotinst:aws:cloudformation:logical-id
• spotinst:aws:cloudformation:stack-name
• spotinst:aws:cloudformation:stack-id

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Parameters": {
    "shouldRoll": {
      "Type": "String",
      "Default": "false",
      "Description": "Should roll when updating"
    },
    "shouldUpdateTargetCapacity": {
      "Type": "String",
      "Default": "true",
      "AllowedValues": ["false", "true"],
      "Description": "Should update target capacity on group update"
    }
  },
  "Resources": {
    "SpotinstElastigroup": {
      "Type": "Custom::elasticgroup",
      "Properties": {
        "updatePolicy": {
          "shouldRoll": {
            "Ref": "shouldRoll"
          },
          "rollConfig": {
            "batchSizePercentage": 50,
            "gracePeriod": 600
          },
          "shouldUpdateTargetCapacity": {
            "Ref": "shouldUpdateTargetCapacity"
          }
        },
        "autoTag": true,
        "group": {}
      }
    }
  }
}

Request JSON Example: Adding Auto Tags to a Kubernetes Ocean Cluster

When you use autoTag in CloudFormation, Spot adds these tracking tags to instances provisioned as part of the custom resource:

• spotinst:aws:cloudformation:logical-id
• spotinst:aws:cloudformation:stack-name
• spotinst:aws:cloudformation:stack-id

{  
   "Resources":{
    "SpotinstOcean": {
      "Type": "Custom::ocean",
      "Properties": {
        "ServiceToken": {
          "AWS::Sub": ["arn:aws:lambda:${Region}:178579023202:function:spotinst-cloudformation"]
        },
        "accessToken": "Spotinst Token",
        "accountId": "Spotinst Account ID",
        "autoTag": true,
        "updatePolicy": {
          "shouldUpdateTargetCapacity": false
          "shouldRoll": 'true'
          "rollConfig": {
            "roll": {
              "batchSizePercentage": 25
            }
          }
        },
        "ocean":{
          "name": "Your Ocean Name",
          "controllerClusterId": "ocean.k8s",
          "region": {
            "AWS::Sub":["${AWS::Region}"]
          },
          "autoScaler":{
            "isEnabled": true,
            "cooldown": 180,
            "resourceLimits":{
              "maxMemoryGib": 1500,
              "maxVCpu": 750
            },
            "down":{
              "evaluationPeriods": 3
            },
            "headroom":{
              "cpuPerUnit": 2000,
              "memoryPerUnit": 0,
              "numOfUnits": 4
            },
            "isAutoConfig": false
          },
          "capacity":{
            "minimum": 0,
            "maximum": 1,
            "target": 1
          },
          "strategy":{
            "spotPercentage": 100,
            "fallbackToOd": true,
            "utilizeReservedInstances": false
          },
          "compute":{
            "subnetIds":[
              ""
            ],
            "instanceTypes":{
              "whitelist":[
                "c4.8xlarge"
              ]
            },
            "launchSpecification":{
              "imageId": "",
              "userData": "12345678987654321",
              "securityGroupIds":[
                ""
              ],
              "iamInstanceProfile":{
                "arn": ""
              },
              "keyPair": "",
              "tags":{
                "tagKey": "creator",
                "tagValue": "test"
              }
            }
          }
        }
      }
    }
  }
}