Skip to content

workflow.v1alpha1.s3ArtifactRepository

"S3ArtifactRepository defines the controller configuration for an S3 artifact repository"

Index

Fields

fn withBucket

withBucket(bucket)

"Bucket is the name of the bucket"

fn withEndpoint

withEndpoint(endpoint)

"Endpoint is the hostname of the bucket endpoint"

fn withInsecure

withInsecure(insecure)

"Insecure will connect to the service with TLS"

fn withKeyFormat

withKeyFormat(keyFormat)

"KeyFormat is defines the format of how to store keys. Can reference workflow variables"

fn withKeyPrefix

withKeyPrefix(keyPrefix)

"KeyPrefix is prefix used as part of the bucket key in which the controller will store artifacts. DEPRECATED. Use KeyFormat instead"

fn withRegion

withRegion(region)

"Region contains the optional bucket region"

fn withRoleARN

withRoleARN(roleARN)

"RoleARN is the Amazon Resource Name (ARN) of the role to assume."

fn withUseSDKCreds

withUseSDKCreds(useSDKCreds)

"UseSDKCreds tells the driver to figure out credentials based on sdk defaults."

obj accessKeySecret

"SecretKeySelector selects a key of a Secret."

fn accessKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn accessKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn accessKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj createBucketIfNotPresent

"CreateS3BucketOptions options used to determine automatic automatic bucket-creation process"

fn createBucketIfNotPresent.withObjectLocking

withObjectLocking(objectLocking)

"ObjectLocking Enable object locking"

obj encryptionOptions

"S3EncryptionOptions used to determine encryption options during s3 operations"

fn encryptionOptions.withEnableEncryption

withEnableEncryption(enableEncryption)

"EnableEncryption tells the driver to encrypt objects if set to true. If kmsKeyId and serverSideCustomerKeySecret are not set, SSE-S3 will be used"

fn encryptionOptions.withKmsEncryptionContext

withKmsEncryptionContext(kmsEncryptionContext)

"KmsEncryptionContext is a json blob that contains an encryption context. See https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context for more information"

fn encryptionOptions.withKmsKeyId

withKmsKeyId(kmsKeyId)

"KMSKeyId tells the driver to encrypt the object using the specified KMS Key."

obj encryptionOptions.serverSideCustomerKeySecret

"SecretKeySelector selects a key of a Secret."

fn encryptionOptions.serverSideCustomerKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn encryptionOptions.serverSideCustomerKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn encryptionOptions.serverSideCustomerKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj secretKeySecret

"SecretKeySelector selects a key of a Secret."

fn secretKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn secretKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn secretKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"