Package software.amazon.awscdk.services.apigateway

Class AssetApiDefinition.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static AssetApiDefinition.Builder create(String path)
      Parameters:
      path - This parameter is required.
      Returns:
      a new instance of AssetApiDefinition.Builder.

    • assetHash

      @Stability(Stable) public AssetApiDefinition.Builder assetHash(String 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.

      Default: - based on `assetHashType`

      Parameters:
      assetHash - Specify a custom hash for this asset. This parameter is required.
      Returns:
      this

    • assetHashType

      @Stability(Stable) public AssetApiDefinition.Builder assetHashType(AssetHashType assetHashType)
      Specifies the type of hash to calculate for this asset.

      If assetHash is configured, this option must be undefined or AssetHashType.CUSTOM.

      Default: - the default is `AssetHashType.SOURCE`, but if `assetHash` is explicitly specified this value defaults to `AssetHashType.CUSTOM`.

      Parameters:
      assetHashType - Specifies the type of hash to calculate for this asset. This parameter is required.
      Returns:
      this

    • bundling

      @Stability(Stable) public AssetApiDefinition.Builder bundling(BundlingOptions 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.

      Default: - uploaded as-is to S3 if the asset is a regular file or a .zip file, archived into a .zip file and uploaded to S3 otherwise

      Parameters:
      bundling - Bundle the asset by executing a command in a Docker container or a custom bundling provider. This parameter is required.
      Returns:
      this

    • exclude

      @Stability(Stable) public AssetApiDefinition.Builder exclude(List<String> exclude)
      File paths matching the patterns will be excluded.

      See ignoreMode to set the matching behavior. Has no effect on Assets bundled using the bundling property.

      Default: - nothing is excluded

      Parameters:
      exclude - File paths matching the patterns will be excluded. This parameter is required.
      Returns:
      this

    • followSymlinks

      @Stability(Stable) public AssetApiDefinition.Builder followSymlinks(SymlinkFollowMode followSymlinks)
      A strategy for how to handle symlinks.

      Default: SymlinkFollowMode.NEVER

      Parameters:
      followSymlinks - A strategy for how to handle symlinks. This parameter is required.
      Returns:
      this

    • ignoreMode

      @Stability(Stable) public AssetApiDefinition.Builder ignoreMode(IgnoreMode ignoreMode)
      The ignore behavior to use for exclude patterns.

      Default: IgnoreMode.GLOB

      Parameters:
      ignoreMode - The ignore behavior to use for exclude patterns. This parameter is required.
      Returns:
      this

    • deployTime

      @Stability(Stable) public AssetApiDefinition.Builder deployTime(Boolean deployTime)
      Whether or not the asset needs to exist beyond deployment time;

      i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds.

      For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets.

      Default: false

      Parameters:
      deployTime - Whether or not the asset needs to exist beyond deployment time;. This parameter is required.
      Returns:
      this

    • readers

      @Stability(Stable) public AssetApiDefinition.Builder readers(List<? extends IGrantable> 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.

      Default: - No principals that can read file asset.

      Parameters:
      readers - A list of principals that should be able to read this asset from S3. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public AssetApiDefinition build()
      Specified by:
      build in interface software.amazon.jsii.Builder<AssetApiDefinition>
      Returns:
      a newly built instance of AssetApiDefinition.