Class InitFileAssetOptions.Jsii$Proxy
- All Implemented Interfaces:
AssetOptions
,FileCopyOptions
,InitFileAssetOptions
,InitFileOptions
,AssetOptions
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
InitFileAssetOptions
InitFileAssetOptions
-
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.ec2.InitFileAssetOptions
InitFileAssetOptions.Builder, InitFileAssetOptions.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(InitFileAssetOptions.Builder builder) Constructor that initializes the object based on literal property values passed by theInitFileAssetOptions.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 Boolean
True if the inlined content (from a string or file) should be treated as base64 encoded.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 String
getGroup()
The name of the owning group for this file.final IgnoreMode
The ignore behavior to use forexclude
patterns.final String
getMode()
A six-digit octal value representing the mode for this file.final String
getOwner()
The name of the owning user for this file.final List<IGrantable>
A list of principals that should be able to read this asset from S3.final List<InitServiceRestartHandle>
Restart the given service after this file has been written.final IKey
The ARN of the KMS key used to encrypt the handler code.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 theInitFileAssetOptions.Builder
.
-
-
Method Details
-
getBase64Encoded
Description copied from interface:InitFileOptions
True if the inlined content (from a string or file) should be treated as base64 encoded.Only applicable for inlined string and file content.
Default: false
- Specified by:
getBase64Encoded
in interfaceInitFileOptions
-
getGroup
Description copied from interface:InitFileOptions
The name of the owning group for this file.Not supported for Windows systems.
Default: 'root'
- Specified by:
getGroup
in interfaceInitFileOptions
-
getMode
Description copied from interface:InitFileOptions
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.
Default: '000644'
- Specified by:
getMode
in interfaceInitFileOptions
-
getOwner
Description copied from interface:InitFileOptions
The name of the owning user for this file.Not supported for Windows systems.
Default: 'root'
- Specified by:
getOwner
in interfaceInitFileOptions
-
getServiceRestartHandles
Description copied from interface:InitFileOptions
Restart the given service after this file has been written.Default: - Do not restart any service
- Specified by:
getServiceRestartHandles
in interfaceInitFileOptions
-
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
-
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 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()
-