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

Class AssetProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • path

      @Stability(Stable) public AssetProps.Builder path(String path)
      Sets the value of AssetProps.getPath()
      Parameters:
      path - The disk location of the asset. This parameter is required. The path should refer to one of the following:

      • A regular file or a .zip file, in which case the file will be uploaded as-is to S3.
      • A directory, in which case it will be archived into a .zip file and uploaded to S3.
      Returns:
      this

    • deployTime

      @Stability(Stable) public AssetProps.Builder deployTime(Boolean deployTime)
      Sets the value of AssetOptions.getDeployTime()
      Parameters:
      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.

      Returns:
      this

    • displayName

      @Stability(Stable) public AssetProps.Builder displayName(String displayName)
      Sets the value of AssetOptions.getDisplayName()
      Parameters:
      displayName - A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used.

      The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as lambda.Code.fromAsset()), this will look like MyFunction/Code.

      We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like /MyBetaStack/MyFunction/Code when you are actually deploying to production.

      Returns:
      this

    • readers

      @Stability(Stable) public AssetProps.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

    • sourceKmsKey

      @Stability(Stable) public AssetProps.Builder sourceKmsKey(IKeyRef sourceKmsKey)
      Sets the value of
      invalid reference 
      AssetProps#getSourceKmsKey
      Parameters:
      sourceKmsKey - The ARN of the KMS key used to encrypt the handler code.
      Returns:
      this

    • assetHash

      @Stability(Stable) public AssetProps.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 AssetProps.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 AssetProps.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

    • exclude

      @Stability(Stable) public AssetProps.Builder exclude(List<String> exclude)
      Sets the value of FileCopyOptions.getExclude()
      Parameters:
      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.
      Returns:
      this

    • followSymlinks

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

    • ignoreMode

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

    • build

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