io.cloudshiftdev.awscdk.services.codebuild.Cache.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-cdk-wrapper Show documentation
Kotlin DSL for AWS CDK
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")

package io.cloudshiftdev.awscdk.services.codebuild

import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import io.cloudshiftdev.awscdk.services.s3.IBucket
import kotlin.Unit
import kotlin.jvm.JvmName

/**
 * Cache options for CodeBuild Project.
 *
 * A cache can store reusable pieces of your build environment and use them across multiple builds.
 *
 * Example:
 *
 * ```
 * Bucket myCachingBucket;
 * Project.Builder.create(this, "Project")
 * .source(Source.bitBucket(BitBucketSourceProps.builder()
 * .owner("awslabs")
 * .repo("aws-cdk")
 * .build()))
 * .cache(Cache.bucket(myCachingBucket))
 * // BuildSpec with a 'cache' section necessary for S3 caching. This can
 * // also come from 'buildspec.yml' in your source.
 * .buildSpec(BuildSpec.fromObject(Map.of(
 * "version", "0.2",
 * "phases", Map.of(
 * "build", Map.of(
 * "commands", List.of("..."))),
 * "cache", Map.of(
 * "paths", List.of("/root/cachedir/ **/*")))))
 * .build();
 * ```
 *
 * [Documentation](https://docs.aws.amazon.com/codebuild/latest/userguide/build-caching.html)
 */
public abstract class Cache(
  cdkObject: software.amazon.awscdk.services.codebuild.Cache,
) : CdkObject(cdkObject) {
  private class Wrapper(
    cdkObject: software.amazon.awscdk.services.codebuild.Cache,
  ) : Cache(cdkObject)

  public companion object {
    public fun bucket(bucket: IBucket): Cache =
        software.amazon.awscdk.services.codebuild.Cache.bucket(bucket.let(IBucket.Companion::unwrap)).let(Cache::wrap)

    public fun bucket(bucket: IBucket, options: BucketCacheOptions): Cache =
        software.amazon.awscdk.services.codebuild.Cache.bucket(bucket.let(IBucket.Companion::unwrap),
        options.let(BucketCacheOptions.Companion::unwrap)).let(Cache::wrap)

    @kotlin.Suppress("INAPPLICABLE_JVM_NAME")
    @JvmName("f6eb3d0edf88b31d8b205a25aad1fee39fac0902b3ecfcfda69f004457e7f5f4")
    public fun bucket(bucket: IBucket, options: BucketCacheOptions.Builder.() -> Unit): Cache =
        bucket(bucket, BucketCacheOptions(options))

    public fun local(modes: LocalCacheMode): Cache =
        software.amazon.awscdk.services.codebuild.Cache.local(modes.let(LocalCacheMode.Companion::unwrap)).let(Cache::wrap)

    public fun none(): Cache =
        software.amazon.awscdk.services.codebuild.Cache.none().let(Cache::wrap)

    internal fun wrap(cdkObject: software.amazon.awscdk.services.codebuild.Cache): Cache =
        CdkObjectWrappers.wrap(cdkObject) as? Cache ?: Wrapper(cdkObject)

    internal fun unwrap(wrapped: Cache): software.amazon.awscdk.services.codebuild.Cache = (wrapped
        as CdkObject).cdkObject as software.amazon.awscdk.services.codebuild.Cache
  }
}