software.amazon.awscdk.services.codebuild

Class Cache

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codebuild.Cache

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:44.931Z")
public abstract class Cache
extends software.amazon.jsii.JsiiObject

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();
 

See Also:

https://docs.aws.amazon.com/codebuild/latest/userguide/build-caching.html

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Cache()
protected	Cache(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Cache(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static Cache	bucket(IBucket bucket) Create an S3 caching strategy.
static Cache	bucket(IBucket bucket, BucketCacheOptions options) Create an S3 caching strategy.
static Cache	local(LocalCacheMode... modes) Create a local caching strategy.
static Cache	none()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Cache

protected Cache(software.amazon.jsii.JsiiObjectRef objRef)

Cache

protected Cache(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Cache

protected Cache()

Method Detail

bucket

public static Cache bucket(IBucket bucket,
                           BucketCacheOptions options)

Create an S3 caching strategy.

Parameters:

bucket - the S3 bucket to use for caching. This parameter is required.

options - additional options to pass to the S3 caching.

bucket

public static Cache bucket(IBucket bucket)

Create an S3 caching strategy.

Parameters:

bucket - the S3 bucket to use for caching. This parameter is required.

local

public static Cache local(LocalCacheMode... modes)

Create a local caching strategy.

Parameters:

modes - the mode(s) to enable for local caching. This parameter is required.

none

public static Cache none()