/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace CodeBuild { namespace Model { /** *

Information about the cache for the build project.

See Also:

* AWS * API Reference

*/ class AWS_CODEBUILD_API ProjectCache { public: ProjectCache(); ProjectCache(Aws::Utils::Json::JsonView jsonValue); ProjectCache& operator=(Aws::Utils::Json::JsonView jsonValue); Aws::Utils::Json::JsonValue Jsonize() const; /** *

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.

  • *
*/ inline const CacheType& GetType() const{ return m_type; } /** *

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.

  • *
*/ inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; } /** *

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.

  • *
*/ inline void SetType(const CacheType& value) { m_typeHasBeenSet = true; m_type = value; } /** *

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.

  • *
*/ inline void SetType(CacheType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); } /** *

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.

  • *
*/ inline ProjectCache& WithType(const CacheType& value) { SetType(value); return *this;} /** *

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.

  • *
*/ inline ProjectCache& WithType(CacheType&& value) { SetType(std::move(value)); return *this;} /** *

Information about the cache location:

  • * NO_CACHE or LOCAL: This value is ignored.

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

*/ inline const Aws::String& GetLocation() const{ return m_location; } /** *

Information about the cache location:

  • * NO_CACHE or LOCAL: This value is ignored.

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

*/ inline bool LocationHasBeenSet() const { return m_locationHasBeenSet; } /** *

Information about the cache location:

  • * NO_CACHE or LOCAL: This value is ignored.

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

*/ inline void SetLocation(const Aws::String& value) { m_locationHasBeenSet = true; m_location = value; } /** *

Information about the cache location:

  • * NO_CACHE or LOCAL: This value is ignored.

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

*/ inline void SetLocation(Aws::String&& value) { m_locationHasBeenSet = true; m_location = std::move(value); } /** *

Information about the cache location:

  • * NO_CACHE or LOCAL: This value is ignored.

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

*/ inline void SetLocation(const char* value) { m_locationHasBeenSet = true; m_location.assign(value); } /** *

Information about the cache location:

  • * NO_CACHE or LOCAL: This value is ignored.

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

*/ inline ProjectCache& WithLocation(const Aws::String& value) { SetLocation(value); return *this;} /** *

Information about the cache location:

  • * NO_CACHE or LOCAL: This value is ignored.

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

*/ inline ProjectCache& WithLocation(Aws::String&& value) { SetLocation(std::move(value)); return *this;} /** *

Information about the cache location:

  • * NO_CACHE or LOCAL: This value is ignored.

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

*/ inline ProjectCache& WithLocation(const char* value) { SetLocation(value); return *this;} /** *

If you use a LOCAL cache, the local cache mode. You can use one * or more local cache modes at the same time.

  • * LOCAL_SOURCE_CACHE mode 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 mode 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 mode 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.

*/ inline const Aws::Vector& GetModes() const{ return m_modes; } /** *

If you use a LOCAL cache, the local cache mode. You can use one * or more local cache modes at the same time.

  • * LOCAL_SOURCE_CACHE mode 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 mode 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 mode 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.

*/ inline bool ModesHasBeenSet() const { return m_modesHasBeenSet; } /** *

If you use a LOCAL cache, the local cache mode. You can use one * or more local cache modes at the same time.

  • * LOCAL_SOURCE_CACHE mode 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 mode 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 mode 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.

*/ inline void SetModes(const Aws::Vector& value) { m_modesHasBeenSet = true; m_modes = value; } /** *

If you use a LOCAL cache, the local cache mode. You can use one * or more local cache modes at the same time.

  • * LOCAL_SOURCE_CACHE mode 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 mode 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 mode 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.

*/ inline void SetModes(Aws::Vector&& value) { m_modesHasBeenSet = true; m_modes = std::move(value); } /** *

If you use a LOCAL cache, the local cache mode. You can use one * or more local cache modes at the same time.

  • * LOCAL_SOURCE_CACHE mode 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 mode 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 mode 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.

*/ inline ProjectCache& WithModes(const Aws::Vector& value) { SetModes(value); return *this;} /** *

If you use a LOCAL cache, the local cache mode. You can use one * or more local cache modes at the same time.

  • * LOCAL_SOURCE_CACHE mode 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 mode 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 mode 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.

*/ inline ProjectCache& WithModes(Aws::Vector&& value) { SetModes(std::move(value)); return *this;} /** *

If you use a LOCAL cache, the local cache mode. You can use one * or more local cache modes at the same time.

  • * LOCAL_SOURCE_CACHE mode 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 mode 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 mode 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.

*/ inline ProjectCache& AddModes(const CacheMode& value) { m_modesHasBeenSet = true; m_modes.push_back(value); return *this; } /** *

If you use a LOCAL cache, the local cache mode. You can use one * or more local cache modes at the same time.

  • * LOCAL_SOURCE_CACHE mode 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 mode 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 mode 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.

*/ inline ProjectCache& AddModes(CacheMode&& value) { m_modesHasBeenSet = true; m_modes.push_back(std::move(value)); return *this; } private: CacheType m_type; bool m_typeHasBeenSet; Aws::String m_location; bool m_locationHasBeenSet; Aws::Vector m_modes; bool m_modesHasBeenSet; }; } // namespace Model } // namespace CodeBuild } // namespace Aws