Package software.amazon.awscdk.services.ec2

Class InitFileAssetOptions.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • base64Encoded

      @Stability(Stable) public InitFileAssetOptions.Builder base64Encoded(Boolean base64Encoded)
      Sets the value of InitFileOptions.getBase64Encoded()
      Parameters:
      base64Encoded - True if the inlined content (from a string or file) should be treated as base64 encoded. Only applicable for inlined string and file content.
      Returns:
      this

    • group

      @Stability(Stable) public InitFileAssetOptions.Builder group(String group)
      Sets the value of InitFileOptions.getGroup()
      Parameters:
      group - The name of the owning group for this file. Not supported for Windows systems.
      Returns:
      this

    • mode

      @Stability(Stable) public InitFileAssetOptions.Builder mode(String mode)
      Sets the value of InitFileOptions.getMode()
      Parameters:
      mode - A six-digit octal value representing the mode for this file. Use the first three digits for symlinks and the last three digits for setting permissions. To create a symlink, specify 120xxx, where xxx defines the permissions of the target file. To specify permissions for a file, use the last three digits, such as 000644.

      Not supported for Windows systems.

      Returns:
      this

    • owner

      @Stability(Stable) public InitFileAssetOptions.Builder owner(String owner)
      Sets the value of InitFileOptions.getOwner()
      Parameters:
      owner - The name of the owning user for this file. Not supported for Windows systems.
      Returns:
      this

    • serviceRestartHandles

      @Stability(Stable) public InitFileAssetOptions.Builder serviceRestartHandles(List<? extends InitServiceRestartHandle> serviceRestartHandles)
      Sets the value of InitFileOptions.getServiceRestartHandles()
      Parameters:
      serviceRestartHandles - Restart the given service after this file has been written.
      Returns:
      this

    • deployTime

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

    • readers

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

    • assetHash

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