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

S3CompatibleStorage

open class S3CompatibleStorage : ProjectFeature

fun ProjectFeatures.s3CompatibleStorage(init: S3CompatibleStorage.() -> Unit): S3CompatibleStorage

S3 Compatible Artifact Storage

Example. Adds new storage that allows TeamCity to store build artifacts in S3

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        s3CompatibleStorage {
          id = "S3_STORAGE_ID"
          storageName = "Storage Name"

          bucketName = "Bucket Name"
          bucketPrefix = "path prefix inside the bucket"

          forceVirtualHostAddressing = true
          enableTransferAcceleration = false
          multipartThreshold = "8MB"
          multipartChunksize = "8MB"

          // Storage also requires configured Credentials
          accessKeyID = "AWS Access key ID"
          accessKey = "Link to credentialsJSON property containing AWS access key"
        }
Content copied to clipboard
    }
}

Example. Credentials. Specifies credentials using access key

connection = customConnection {
  accessKeyID = "AWS Access key ID"
  accessKey = "Link to credentialsJSON property containing AWS access key"
}

Constructors

S3CompatibleStorage

fun S3CompatibleStorage(init: S3CompatibleStorage.() -> Unit)

S3CompatibleStorage

fun S3CompatibleStorage()

Functions

booleanParameter

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

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): CompoundDelegateProvider<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

fun doubleParameter(customName: String? = null): SingleDelegateProvider<Double>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): SingleDelegateProvider<E>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): SingleDelegateProvider<Int>

param

fun param(name: String, value: String)

Adds parameter with specified name and value

removeRawParam

fun removeRawParam(paramName: String)

stringParameter

fun stringParameter(customName: String? = null): SingleDelegateProvider<String>

toString

open override fun toString(): String

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

accessKey

var accessKey: String?

Account secret access key

accessKeyID

var accessKeyID: String?

Account access key ID

bucketName

var bucketName: String?

Bucket name

bucketPrefix

var bucketPrefix: String?

Bucket path prefix

enablePresignedURLUpload

var enablePresignedURLUpload: Boolean?

Whether to use Pre-Signed URLs to upload

endpoint

var endpoint: String?

Endpoint URL

forceVirtualHostAddressing

var forceVirtualHostAddressing: Boolean?

Whether to force Virtual Host Addressing

var id: String? = null

Project feature id, if not specified will be generated

multipartChunksize

var multipartChunksize: String?

Specify the maximum allowed part size. Minimum value is 5MB. Allowed suffixes: KB, MB, GB, TB. Leave empty to use the default value.

multipartThreshold

var multipartThreshold: String?

Initiates multipart upload for files larger than the specified value. Minimum value is 5MB. Allowed suffixes: KB, MB, GB, TB. Leave empty to use the default value.

params

val params: List<Parameter>

storageName

var storageName: String?

Storage name

type

var type: String

Project feature type

S3CompatibleStorage

See also

Constructors

Functions

Properties