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"

          forceVirtualHostAddressing = true
          verifyIntegrityAfterUpload = false

          multipartThreshold = "8MB"
          multipartChunksize = "8MB"

          // Endpoint is required:
          endpoint = "https://s3-compatible-endpoint.com"
          // Storage also requires configured Credentials
          accessKeyID = "Access key ID"
          accessKey = "credentialsJSON:link-to-property-containing-access-key"
        }
















Content copied to clipboard
    }
}

Constructors

S3CompatibleStorage

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

constructor()

Properties

accessKey

var accessKey: <Error class: unknown class>

Account secret access key

accessKeyID

var accessKeyID: <Error class: unknown class>

Account access key ID

bucketName

var bucketName: <Error class: unknown class>

Bucket name

bucketPrefix

var bucketPrefix: <Error class: unknown class>

Bucket path prefix

enablePresignedURLUpload

var enablePresignedURLUpload: <Error class: unknown class>

Whether to use Pre-Signed URLs to upload

endpoint

var endpoint: <Error class: unknown class>

Endpoint URL

forceVirtualHostAddressing

var forceVirtualHostAddressing: <Error class: unknown class>

Whether to force Virtual Host Addressing

var id: String?

Project feature id, if not specified will be generated

multipartChunksize

var multipartChunksize: <Error class: unknown class>

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: <Error class: unknown class>

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: <Error class: unknown class>

Storage name

type

var type: String

Project feature type

verifyIntegrityAfterUpload

var verifyIntegrityAfterUpload: <Error class: unknown class>

Whether to verify integrity of artifacts after upload

Functions

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.

doubleParameter

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

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