TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.projectFeatures/DockerECRConnection

DockerECRConnection

open class DockerECRConnection : ProjectFeature

fun ProjectFeatures.dockerECRRegistry(init: DockerECRConnection.() -> Unit): DockerECRConnection

This connection is used in Docker Support build feature.

Example. Configure a private Amazon ECR connection. The connection is authenticated with AMAZON_KEY_ID and the secret access key, stored outside of VCS in the TeamCity credentials storage.

project {
    ...
    features {
        dockerECRRegistry {
            id = "PROJECT_EXT_01"
            displayName = "Amazon ECR connection"
            ecrType = ecrPrivate()

            registryId = "112233"     // aws_account_id in https://aws_account_id.dkr.ecr.region.amazonaws.com
            regionCode = "us-east-1"  // region in https://aws_account_id.dkr.ecr.region.amazonaws.com

            credentialsType = accessKeys()
            credentialsProvider = accessKey {
                accessKeyId = "AMAZON_KEY_ID"
                secretAccessKey = "credentialsJSON:******"
            }
        }
    }
}

Constructors

DockerECRConnection

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

constructor()

Types

CredentialsProvider

sealed class CredentialsProvider : CompoundParam<DockerECRConnection.CredentialsProvider>

CredentialsType

sealed class CredentialsType : CompoundParam<DockerECRConnection.CredentialsType>

EcrType

sealed class EcrType : CompoundParam<DockerECRConnection.EcrType>

Properties

credentialsProvider

var credentialsProvider: <Error class: unknown class>

credentialsType

var credentialsType: <Error class: unknown class>

AWS Credentials Type

displayName

var displayName: <Error class: unknown class>

ECR connection display name

ecrType

var ecrType: <Error class: unknown class>

ECR type (defaults to ECR Private)

var id: String?

Project feature id, if not specified will be generated

params

val params: List<Parameter>

regionCode

var regionCode: <Error class: unknown class>

AWS region code. For example, us-east-1

registryId

var registryId: <Error class: unknown class>

Registry ID (equals to Amazon Account ID) - a 12-digit number, such as 123456789012

type

var type: String

Project feature type

Functions

accessKey

fun accessKey(init: DockerECRConnection.CredentialsProvider.AccessKey.() -> Unit = {}): DockerECRConnection.CredentialsProvider.AccessKey

accessKeys

fun accessKeys(): DockerECRConnection.CredentialsType.AccessKeys

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, 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.

defaultCredentialsProvider

fun defaultCredentialsProvider(): DockerECRConnection.CredentialsProvider.DefaultCredentialsProvider

Use Default Credentials Provider Chain

doubleParameter

fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

ecrPrivate

fun ecrPrivate(): DockerECRConnection.EcrType.EcrPrivate

ECR Private (default)

ecrPublic

fun ecrPublic(): DockerECRConnection.EcrType.EcrPublic

ECR Public

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

findRawParam