Package software.amazon.awscdk.services.s3.assets

Class AssetOptions.Builder

java.lang.Object
software.amazon.awscdk.services.s3.assets.AssetOptions.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<AssetOptions>
Enclosing interface:
AssetOptions
@Stability(Stable) public static final class AssetOptions.Builder extends Object implements software.amazon.jsii.Builder<AssetOptions>
A builder for AssetOptions

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • readers

      @Stability(Stable) public AssetOptions.Builder readers(List<? extends IGrantable> readers)
      Sets the value of AssetOptions.getReaders()
      Parameters:
      readers - A list of principals that should be able to read this asset from S3. You can use asset.grantRead(principal) to grant read permissions later.
      Returns:
      this

    • sourceHash

      @Stability(Deprecated) @Deprecated public AssetOptions.Builder sourceHash(String sourceHash)
      Deprecated.
      see `assetHash` and `assetHashType`
      Sets the value of AssetOptions.getSourceHash()
      Parameters:
      sourceHash - Custom hash to use when identifying the specific version of the asset. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash.

      NOTE: the source hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the source hash, you will need to make sure it is updated every time the source changes, or otherwise it is possible that some deployments will not be invalidated.

      Returns:
      this

    • exclude

      @Stability(Stable) public AssetOptions.Builder exclude(List<String> exclude)
      Sets the value of AssetOptions.getExclude()
      Parameters:
      exclude - Glob patterns to exclude from the copy.
      Returns:
      this

    • follow

      @Stability(Deprecated) @Deprecated public AssetOptions.Builder follow(FollowMode follow)
      Deprecated.
      use `followSymlinks` instead
      Sets the value of CopyOptions.getFollow()
      Parameters:
      follow - A strategy for how to handle symlinks.
      Returns:
      this

    • ignoreMode

      @Stability(Stable) public AssetOptions.Builder ignoreMode(IgnoreMode ignoreMode)
      Sets the value of AssetOptions.getIgnoreMode()
      Parameters:
      ignoreMode - The ignore behavior to use for exclude patterns.
      Returns:
      this

    • followSymlinks

      @Stability(Stable) public AssetOptions.Builder followSymlinks(SymlinkFollowMode followSymlinks)
      Sets the value of FileCopyOptions.getFollowSymlinks()
      Parameters:
      followSymlinks - A strategy for how to handle symlinks.
      Returns:
      this

    • assetHash

      @Stability(Stable) public AssetOptions.Builder assetHash(String assetHash)
      Sets the value of AssetOptions.getAssetHash()
      Parameters:
      assetHash - Specify a custom hash for this asset. If assetHashType is set it must be set to AssetHashType.CUSTOM. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash.

      NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated.

      Returns:
      this

    • assetHashType

      @Stability(Stable) public AssetOptions.Builder assetHashType(AssetHashType assetHashType)
      Sets the value of AssetOptions.getAssetHashType()
      Parameters:
      assetHashType - Specifies the type of hash to calculate for this asset. If assetHash is configured, this option must be undefined or AssetHashType.CUSTOM.
      Returns:
      this

    • bundling

      @Stability(Stable) public AssetOptions.Builder bundling(BundlingOptions bundling)
      Sets the value of AssetOptions.getBundling()
      Parameters:
      bundling - Bundle the asset by executing a command in a Docker container or a custom bundling provider. The asset path will be mounted at /asset-input. The Docker container is responsible for putting content at /asset-output. The content at /asset-output will be zipped and used as the final asset.
      Returns:
      this

    • build

      @Stability(Stable) public AssetOptions build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<AssetOptions>
      Returns:
      a new instance of AssetOptions
      Throws:
      NullPointerException - if any required attribute was not provided