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

AmazonEC2CloudProfile

open class AmazonEC2CloudProfile : CloudProfile

fun ProjectFeatures.amazonEC2CloudProfile(init: AmazonEC2CloudProfile.() -> Unit = {})

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

Example. EC2 Cloud Profile using secret keys

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        amazonEC2CloudProfile {
            id = "amazon-1"
            name = "Amazon EC2 - 1"
            description = "Profile Description"
            region = AmazonEC2CloudProfile.Regions.US_WEST_N_CALIFORNIA

            authType = accessKey {
                keyId = "CEA4D6NX8JL4RDQZ3VX1"
                secretKey = "credentialsJson:******"
            }
        }
Content copied to clipboard
    }
}

Example. Disabled EC2 Cloud Profile using instance's IAM profile, and a different server URL that will either terminate in 30 minutes or after it finishes the build

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        amazonEC2CloudProfile {
            enabled = false
            id = "amazon-1"
            name = "Amazon EC2 - 1"
            description = "Profile Description"
            region = AmazonEC2CloudProfile.Regions.US_WEST_N_CALIFORNIA
            authType = instanceIAMRole()
            serverURL = "https://jetbrains.com/teamcity"
            terminateBeforeFullHourMinutes = 30
            terminateAfterBuild = true
            maxInstancesCount = 1
        }
Content copied to clipboard
    }
}

Constructors

AmazonEC2CloudProfile

constructor(init: AmazonEC2CloudProfile.() -> Unit)

Types

AuthType

sealed class AuthType : CompoundParam<AmazonEC2CloudProfile.AuthType>

Regions

object Regions

Properties

authType

var authType: AmazonEC2CloudProfile.AuthType?

description

var description: String?

enabled

var enabled: Boolean?

var id: String?

Project feature id, if not specified will be generated

maxInstancesCount

var maxInstancesCount: Int?

name

var name: String?

params

val params: List<Parameter>

region

var region: String?

serverURL

var serverURL: String?

terminateAfterBuild

var terminateAfterBuild: Boolean?

terminateBeforeFullHourMinutes

var terminateBeforeFullHourMinutes: Int?

terminateIdleMinutes

var terminateIdleMinutes: Int?

terminateTotalWorkMinutes

var terminateTotalWorkMinutes: Int?

type

var type: String

Project feature type

Functions

accessKey

fun accessKey(init: AmazonEC2CloudProfile.AuthType.AccessKey.() -> Unit = {}): AmazonEC2CloudProfile.AuthType.AccessKey

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