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

Class AssetProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.s3.assets.AssetProps.Jsii$Proxy
All Implemented Interfaces:
AssetOptions, FileCopyOptions, AssetOptions, AssetProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
AssetProps
@Stability(Stable) @Internal public static final class AssetProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements AssetProps
An implementation for AssetProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(AssetProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the AssetProps.Builder.

  • Method Details

    • getPath

      public final String getPath()
      Description copied from interface: AssetProps
      The disk location of the asset.

      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.
      Specified by:
      getPath in interface AssetProps

    • getDeployTime

      public final Boolean getDeployTime()
      Description copied from interface: AssetOptions
      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

      Specified by:
      getDeployTime in interface AssetOptions

    • getDisplayName

      public final String getDisplayName()
      Description copied from interface: AssetOptions
      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.

      Default: - Stack-relative construct path

      Specified by:
      getDisplayName in interface AssetOptions

    • getReaders

      public final List<IGrantable> getReaders()
      Description copied from interface: AssetOptions
      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.

      Specified by:
      getReaders in interface AssetOptions

    • getSourceKMSKey

      public final IKeyRef getSourceKMSKey()
      Description copied from interface: AssetOptions
      The ARN of the KMS key used to encrypt the handler code.

      Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.

      Specified by:
      getSourceKMSKey in interface AssetOptions

    • getAssetHash

      public final String getAssetHash()
      Description copied from interface: AssetOptions
      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`

      Specified by:
      getAssetHash in interface AssetOptions

    • getAssetHashType

      public final AssetHashType getAssetHashType()
      Description copied from interface: AssetOptions
      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`.

      Specified by:
      getAssetHashType in interface AssetOptions

    • getBundling

      public final BundlingOptions getBundling()
      Description copied from interface: AssetOptions
      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

      Specified by:
      getBundling in interface AssetOptions

    • getExclude

      public final List<String> getExclude()
      Description copied from interface: FileCopyOptions
      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

      Specified by:
      getExclude in interface FileCopyOptions

    • getFollowSymlinks

      public final SymlinkFollowMode getFollowSymlinks()
      Description copied from interface: FileCopyOptions
      A strategy for how to handle symlinks.

      Default: SymlinkFollowMode.NEVER

      Specified by:
      getFollowSymlinks in interface FileCopyOptions

    • getIgnoreMode

      public final IgnoreMode getIgnoreMode()
      Description copied from interface: FileCopyOptions
      The ignore behavior to use for exclude patterns.

      Default: IgnoreMode.GLOB

      Specified by:
      getIgnoreMode in interface FileCopyOptions

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object