Struct ProjectCache

#[non_exhaustive]
pub struct ProjectCache {
    pub type: CacheType,
    pub location: Option<String>,
    pub modes: Option<Vec<CacheMode>>,
    pub cache_namespace: Option<String>,
}

Information about the cache for the build project.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

type: CacheType

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.

location: Option<String>

Information about the cache location:

• NO_CACHE or LOCAL: This value is ignored.

• S3: This is the S3 bucket name/prefix.

modes: Option<Vec<CacheMode>>

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_SOURCE_CACHE

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_DOCKER_LAYER_CACHE

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_CUSTOM_CACHE

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.

cache_namespace: Option<String>

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 in the CodeBuild User Guide.

Implementations

impl ProjectCache

pub fn type(&self) -> &CacheType

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.

pub fn location(&self) -> Option<&str>

Information about the cache location:

• NO_CACHE or LOCAL: This value is ignored.

• S3: This is the S3 bucket name/prefix.

pub fn modes(&self) -> &[CacheMode]

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_SOURCE_CACHE

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_DOCKER_LAYER_CACHE

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_CUSTOM_CACHE

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .modes.is_none().

pub fn cache_namespace(&self) -> Option<&str>

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 in the CodeBuild User Guide.

impl ProjectCache

pub fn builder() -> ProjectCacheBuilder

Creates a new builder-style object to manufacture ProjectCache.

Trait Implementations

impl Clone for ProjectCache

fn clone(&self) -> ProjectCache

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProjectCache

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ProjectCache

fn eq(&self, other: &ProjectCache) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ProjectCache