Class CustomCommandOptions.Builder

java.lang.Object
software.amazon.awscdk.services.lambda.CustomCommandOptions.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CustomCommandOptions>
Enclosing interface:
CustomCommandOptions

@Stability(Stable) public static final class CustomCommandOptions.Builder extends Object implements software.amazon.jsii.Builder<CustomCommandOptions>
A builder for CustomCommandOptions
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • commandOptions

      @Stability(Stable) public CustomCommandOptions.Builder commandOptions(Map<String,? extends Object> commandOptions)
      Parameters:
      commandOptions - options that are passed to the spawned process, which determine the characteristics of the spawned process.
      Returns:
      this
    • deployTime

      @Stability(Stable) public CustomCommandOptions.Builder deployTime(Boolean deployTime)
      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
    • readers

      @Stability(Stable) public CustomCommandOptions.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 CustomCommandOptions.Builder sourceKmsKey(IKey sourceKmsKey)
      Sets the value of
      invalid @link
      CustomCommandOptions#getSourceKmsKey
      Parameters:
      sourceKmsKey - The ARN of the KMS key used to encrypt the handler code.
      Returns:
      this
    • assetHash

      @Stability(Stable) public CustomCommandOptions.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 CustomCommandOptions.Builder assetHashType(AssetHashType assetHashType)
      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 CustomCommandOptions.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 CustomCommandOptions.Builder exclude(List<String> exclude)
      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 CustomCommandOptions.Builder followSymlinks(SymlinkFollowMode followSymlinks)
      Parameters:
      followSymlinks - A strategy for how to handle symlinks.
      Returns:
      this
    • ignoreMode

      @Stability(Stable) public CustomCommandOptions.Builder ignoreMode(IgnoreMode ignoreMode)
      Parameters:
      ignoreMode - The ignore behavior to use for exclude patterns.
      Returns:
      this
    • build

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