This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::CodeBuild::Project ProjectCache
<a name="aws-properties-codebuild-project-projectcache"></a>

`ProjectCache` is a property of the [AWS CodeBuild Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies information about the cache for the build project. If `ProjectCache` is not specified, then both of its properties default to `NO_CACHE`.

## Syntax
<a name="aws-properties-codebuild-project-projectcache-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-projectcache-syntax.json"></a>

```
{
  "[CacheNamespace](#cfn-codebuild-project-projectcache-cachenamespace)" : String,
  "[Location](#cfn-codebuild-project-projectcache-location)" : String,
  "[Modes](#cfn-codebuild-project-projectcache-modes)" : [ String, ... ],
  "[Type](#cfn-codebuild-project-projectcache-type)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-projectcache-syntax.yaml"></a>

```
  [CacheNamespace](#cfn-codebuild-project-projectcache-cachenamespace): String
  [Location](#cfn-codebuild-project-projectcache-location): String
  [Modes](#cfn-codebuild-project-projectcache-modes): 
    - String
  [Type](#cfn-codebuild-project-projectcache-type): String
```

## Properties
<a name="aws-properties-codebuild-project-projectcache-properties"></a>

`CacheNamespace`  <a name="cfn-codebuild-project-projectcache-cachenamespace"></a>
Defines the scope of the cache. You can use this namespace to share a cache across multiple projects. For more information, see [Cache sharing between projects](https://docs.aws.amazon.com/codebuild/latest/userguide/caching-s3.html#caching-s3-sharing) in the *AWS CodeBuild User Guide*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Location`  <a name="cfn-codebuild-project-projectcache-location"></a>
Information about the cache location:   
+ `NO_CACHE` or `LOCAL`: This value is ignored.
+ `S3`: This is the S3 bucket name/prefix.
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Modes`  <a name="cfn-codebuild-project-projectcache-modes"></a>
An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for `LOCAL` cache types.  
Possible values are:    
LOCAL\$1SOURCE\$1CACHE  
Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.   
LOCAL\$1DOCKER\$1LAYER\$1CACHE  
Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.   
+ You can use a Docker layer cache in the Linux environment only. 
+ The `privileged` flag must be set so that your project has the required Docker permissions. 
+ You should consider the security implications before you use a Docker layer cache.   
LOCAL\$1CUSTOM\$1CACHE  
Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:   
+ Only directories can be specified for caching. You cannot specify individual files. 
+ Symlinks are used to reference cached directories. 
+ Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file. 
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-codebuild-project-projectcache-type"></a>
The type of cache used by the build project. Valid values include:  
+ `NO_CACHE`: The build project does not use any cache.
+ `S3`: The build project reads and writes from and to S3.
+ `LOCAL`: The build project stores a cache locally on a build host that is only available to that build host.
*Required*: Yes  
*Type*: String  
*Allowed values*: `NO_CACHE | S3 | LOCAL`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-codebuild-project-projectcache--seealso"></a>
+ [ ProjectCache](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_ProjectCache.html) in the *AWS CodeBuild API Reference*