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

S3Storage

fun ProjectFeatures.s3Storage(init: S3Storage.() -> Unit): S3Storage

Amazon S3 Artifact Storage

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

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        s3Storage {
          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 requires configured AwsEnvironment
          awsEnvironment = default {
            awsRegionName = "AWS region"
          }

          // Storage also requires configured Credentials
          connection = awsConnection {
            connectionId = "AWS Connection ID"
          }
        }
Content copied to clipboard
    }
}

Example. Adds new storage that allows TeamCity to store build artifacts in S3 and upload/download them using CloudFront

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        s3Storage {
          id = "S3_STORAGE_ID"
          storageName = "Storage Name"
          bucketName = "Bucket Name"
          bucketPrefix = "path prefix inside the bucket"
          forceVirtualHostAddressing = true
          multipartThreshold = "6MB"
          multipartChunksize = "8MB"

          //CloudFront configuration
          cloudFrontEnabled = true
          cloudFrontUploadDistribution = "ID of CloudFront Distribution used for uploads"
          cloudFrontDownloadDistribution = "ID of CloudFront Distribution used for downloads"
          cloudFrontPublicKeyId = "ID of CloudFront public key"
          cloudFrontPrivateKey = "Link to credentialsJSON property containing CloudFront private key"

          // Storage requires configured AwsEnvironment
          awsEnvironment = default {
            awsRegionName = "AWS region"
          }

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

Example. AWSEnvironment. Selects default environment with specific AWS region

awsEnvironment = default {
  awsRegionName = "AWS region"
}

Example. AWSEnvironment. Selects custom environment with specific region

awsEnvironment = custom {
  endpoint = "URL of custom endpoint"
  awsRegionName = "region"
}

Example. Credentials. Specifies credentials using an ID of configured AWS Connection. @see AwsConnection

connection = awsConnection {
    connectionId = "AWS Connection ID"
}

Example. Credentials. Specifies credentials using access key

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

Example. Credentials. Specifies credentials using default provider chain

useDefaultCredentialProviderChain = true

Constructors

S3Storage

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

S3Storage

fun S3Storage()

Types

AwsEnvironment

sealed class AwsEnvironment : CompoundParam<S3Storage.AwsEnvironment>

Credentials

sealed class Credentials : CompoundParam<S3Storage.Credentials>

Functions

accessKeys

fun accessKeys(): S3Storage.Credentials.AccessKeys

Use pre-configured AWS account access keys

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.

custom

fun custom(init: S3Storage.AwsEnvironment.Custom.() -> Unit = {}): S3Storage.AwsEnvironment.Custom

default

fun default(init: S3Storage.AwsEnvironment.Default.() -> Unit = {}): S3Storage.AwsEnvironment.Default

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>

temporary

fun temporary(init: S3Storage.Credentials.Temporary.() -> Unit = {}): S3Storage.Credentials.Temporary

Get temporary access keys via AWS STS

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?

AWS account secret access key

accessKeyID

var accessKeyID: String?

AWS account access key ID

awsEnvironment

var awsEnvironment: S3Storage.AwsEnvironment?

bucketName

var bucketName: String?

Bucket name

bucketPrefix

var bucketPrefix: String?

Bucket path prefix

cloudFrontDownloadDistribution

var cloudFrontDownloadDistribution: String?

Name of CloudFront distribution for downloads

cloudFrontEnabled

var cloudFrontEnabled: Boolean?

Whether to use CloudFront for artifact transport

cloudFrontPrivateKey

var cloudFrontPrivateKey: String?

Private key that corresponds to chosen public key

cloudFrontPublicKeyId

var cloudFrontPublicKeyId: String?

Id of Public Key in CloudFront that has access to selected distribution

cloudFrontUploadDistribution

var cloudFrontUploadDistribution: String?

Name of CloudFront distribution for uploads

credentials

var credentials: S3Storage.Credentials?

enablePresignedURLUpload

var enablePresignedURLUpload: Boolean?

Whether to use Pre-Signed URLs to upload

enableTransferAcceleration

var enableTransferAcceleration: Boolean?

Whether to enable Transfer Acceleration

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