TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin/AmazonEC2CloudImage

AmazonEC2CloudImage

open class AmazonEC2CloudImage : CloudImage

fun ProjectFeatures.amazonEC2CloudImage(init: AmazonEC2CloudImage.() -> Unit = {})

Definition of a cloud image for a cloud profile agent cloud profile for AWS EC2 in a project.

Example. EC2 Cloud Image using an AMI with a VPC

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        amazonEC2CloudImage {
            name = "name"
            profileId = "amazon-1"
            source = AMI("ami-463edb31")
            vpcSubnetId = "subnet-045436575f4ega1d5"
            iamProfile = "some_iamProfile"
            instanceType = "t2.nano"
        }
Content copied to clipboard
    }
}

Example. EC2 Cloud Image using an AMI with a VPC and image priority

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        amazonEC2CloudImage {
            name = "name"
            profileId = "amazon-1"
            source = AMI("ami-463edb31")
            vpcSubnetId = "subnet-045436575f4ega1d5"
            iamProfile = "some_iamProfile"
            instanceType = "t2.nano"
            imagePriority = 100
        }
Content copied to clipboard
    }
}

Example. EC2 Cloud Image using a specific Instance with a VPC, a key pair, optimized for ebs, with security groups, using spot instances and that injects a custom script on agent startup

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        amazonEC2CloudImage {
            name = "name"
            profileId = "amazon-1"
            source = Instance("ami-463edb31")
            vpcSubnetId = "subnet-045436575f4ega1d5"
            iamProfile = "some_iamProfile"
            keyPairName = "some_kpname"
            instanceType = "t2.nano"
            ebsOptimized = true
            securityGroups = listOf("sec1", "sec2")
            userScript = "sh ~/custom_script.sh"
            useSpotInstances = true
            spotInstanceBidPrice = 5.0
            instanceTags = mapOf("a" to "aa", "b" to "bb")
            maxInstancesCount = 5
            agentPoolId = "some_agent_pool"
        }
Content copied to clipboard
    }
}

Example. EC2 Cloud Image using a Spot Fleet config

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        amazonEC2CloudImage {
            name = "name"
            profileId = "amazon-1"
            source = SpotFleetConfig("""
                      {
                            "IamFleetRole": "arn:aws:iam::913206223978:role/aws-ec2-spot-fleet-tagging-role",
                            "AllocationStrategy": "priceCapacityOptimized",
                            "TargetCapacity": 1,
                            "TerminateInstancesWithExpiration": true,
                            "Type": "request",
                            "TargetCapacityUnitType": "units",
                            "SpotPrice": "183.3",
                            "LaunchSpecifications": [
                                {
                                    "ImageId": "ami-0f31q9ce40194e750",
                                    "KeyName": "key-pair",
                                    "BlockDeviceMappings": [
                                        {
                                            "DeviceName": "/dev/xvda",
                                            "Ebs": {
                                                "DeleteOnTermination": true,
                                                "SnapshotId": "snap-0682e88d8f0cb1ee8",
                                                "VolumeSize": 8,
                                                "VolumeType": "gp2",
                                                "Encrypted": false
                                            }
                                        }
                                    ],
                                    "SubnetId": "subnet-01d36cf70ff187181",
                                    "InstanceRequirements": {
                                        "VCpuCount": {
                                            "Min": 2
                                        },
                                        "MemoryMiB": {
                                            "Min": 2048
                                        }
                                    }
                                }
                            ]
                        }
                        """.trimIndent())
        }
Content copied to clipboard
    }
}

Constructors

AmazonEC2CloudImage

constructor(init: AmazonEC2CloudImage.() -> Unit = {})

Types

AMI

inner class AMI(ami: String) : AmazonEC2CloudImage.Source

Companion

object Companion

Image

inner class Image(imageId: String) : AmazonEC2CloudImage.Source

Instance

inner class Instance(instanceId: String) : AmazonEC2CloudImage.Source

LaunchTemplate

inner class LaunchTemplate(templateId: String, version: String = AmazonEC2CloudImage.DEFAULT_VERSION) : AmazonEC2CloudImage.Source

PublicAMI

inner class ~~PublicAMI~~(publicAMI: String) : AmazonEC2CloudImage.Source

Source

open inner class Source(source: String)

SpotFleetConfig

inner class SpotFleetConfig(spotFleetConfig: String) : AmazonEC2CloudImage.Source

Properties

agentPoolId

var agentPoolId: String?

autoAssignPublicIP

var autoAssignPublicIP: Boolean?

availabilityZone

var availabilityZone: String?

customizeLaunchTemplate

var customizeLaunchTemplate: Boolean?

dedicatedHostsTags

var dedicatedHostsTags: Map<String, String>?

ebsOptimized

var ebsOptimized: Boolean?

iamProfile

var iamProfile: String?

var id: String?

Project feature id, if not specified will be generated

imagePriority

var imagePriority: Int?

instanceTags

var instanceTags: Map<String, String>?

instanceType

var instanceType: String?

keyPairName

var keyPairName: String?

launchTemplateCustomAmi

var launchTemplateCustomAmi: String?

maxInstancesCount

var maxInstancesCount: Int?

name

var name: String?

params

val params: List<Parameter>

profileId

var profileId: String?

securityGroups

var securityGroups: List<String>?

source

var source: AmazonEC2CloudImage.Source?

spotInstanceBidPrice

var spotInstanceBidPrice: Double?

type

var type: String

Project feature type

userScript

var userScript: String?

useSpotInstances

var useSpotInstances: Boolean?

vpcSubnetId

var vpcSubnetId: String?

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean?>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): ProjectFeature

Creates an instance of this project feature via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

doubleParameter