Class AssetProps.Jsii$Proxy
- All Implemented Interfaces:
AssetOptions
,FileCopyOptions
,AssetOptions
,AssetProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
AssetProps
AssetProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.s3.assets.AssetProps
AssetProps.Builder, AssetProps.Jsii$Proxy
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Jsii$Proxy
(AssetProps.Builder builder) Constructor that initializes the object based on literal property values passed by theAssetProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final String
Specify a custom hash for this asset.final AssetHashType
Specifies the type of hash to calculate for this asset.final BundlingOptions
Bundle the asset by executing a command in a Docker container or a custom bundling provider.final Boolean
Whether or not the asset needs to exist beyond deployment time;File paths matching the patterns will be excluded.final SymlinkFollowMode
A strategy for how to handle symlinks.final IgnoreMode
The ignore behavior to use forexclude
patterns.final String
getPath()
The disk location of the asset.final List<IGrantable>
A list of principals that should be able to read this asset from S3.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
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
Constructor that initializes the object based on literal property values passed by theAssetProps.Builder
.
-
-
Method Details
-
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 interfaceAssetProps
-
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 interfaceAssetOptions
-
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 interfaceAssetOptions
-
getAssetHash
Description copied from interface:AssetOptions
Specify a custom hash for this asset.If
assetHashType
is set it must be set toAssetHashType.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 interfaceAssetOptions
-
getAssetHashType
Description copied from interface:AssetOptions
Specifies the type of hash to calculate for this asset.If
assetHash
is configured, this option must beundefined
orAssetHashType.CUSTOM
.Default: - the default is `AssetHashType.SOURCE`, but if `assetHash` is explicitly specified this value defaults to `AssetHashType.CUSTOM`.
- Specified by:
getAssetHashType
in interfaceAssetOptions
-
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 interfaceAssetOptions
-
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 thebundling
property.Default: - nothing is excluded
- Specified by:
getExclude
in interfaceFileCopyOptions
-
getFollowSymlinks
Description copied from interface:FileCopyOptions
A strategy for how to handle symlinks.Default: SymlinkFollowMode.NEVER
- Specified by:
getFollowSymlinks
in interfaceFileCopyOptions
-
getIgnoreMode
Description copied from interface:FileCopyOptions
The ignore behavior to use forexclude
patterns.Default: IgnoreMode.GLOB
- Specified by:
getIgnoreMode
in interfaceFileCopyOptions
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-