Struct aws_sdk_codebuild::types::builders::ProjectCacheBuilder

#[non_exhaustive]
pub struct ProjectCacheBuilder { /* private fields */ }

A builder for ProjectCache.

Implementations

impl ProjectCacheBuilder

pub fn type(self, input: CacheType) -> Self

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.

This field is required.

pub fn set_type(self, input: Option<CacheType>) -> Self

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 get_type(&self) -> &Option<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, input: impl Into<String>) -> Self

Information about the cache location:

• NO_CACHE or LOCAL: This value is ignored.

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

pub fn set_location(self, input: Option<String>) -> Self

Information about the cache location:

• NO_CACHE or LOCAL: This value is ignored.

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

pub fn get_location(&self) -> &Option<String>

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, input: CacheMode) -> Self

Appends an item to modes.

To override the contents of this collection use set_modes.

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.

pub fn set_modes(self, input: Option<Vec<CacheMode>>) -> Self

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.

pub fn get_modes(&self) -> &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.

pub fn build(self) -> Result<ProjectCache, BuildError>

Consumes the builder and constructs a ProjectCache. This method will fail if any of the following fields are not set:

• r#type

Trait Implementations

impl Clone for ProjectCacheBuilder

fn clone(&self) -> ProjectCacheBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectCacheBuilder

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

Formats the value using the given formatter.

impl Default for ProjectCacheBuilder

fn default() -> ProjectCacheBuilder

Returns the “default value” for a type.

impl PartialEq for ProjectCacheBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ProjectCacheBuilder