software.amazon.awscdk.core

Class AssetStaging

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.AssetStaging

All Implemented Interfaces:

IDependable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.5.0 (build 46538f8)",
           date="2020-05-15T23:35:45.924Z")
 @Stability(value=Stable)
public class AssetStaging
extends Construct

Stages a file or directory from a location on the file system into a staging directory.

This is controlled by the context key 'aws:cdk:asset-staging' and enabled by the CLI by default in order to ensure that when the CDK app exists, all assets are available for deployment. Otherwise, if an app references assets in temporary locations, those will not be available when it exists (see https://github.com/aws/aws-cdk/issues/1716).

The stagedPath property is a stringified token that represents the location of the file or directory after staging. It will be resolved only during the "prepare" stage and may be either the original path or the staged path depending on the context setting.

The file/directory are staged based on their content hash (fingerprint). This means that only if content was changed, copy will happen.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AssetStaging.Builder A fluent builder for AssetStaging.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	AssetStaging(Construct scope, String id, AssetStagingProps props)
protected	AssetStaging(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AssetStaging(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getSourceHash() A cryptographic hash of the source document(s).
String	getSourcePath() The path of the asset as it was referenced by the user.
String	getStagedPath() The path to the asset (stringinfied token).
protected void	synthesize(ISynthesisSession session) Allows this construct to emit artifacts into the cloud assembly during synthesis.

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

AssetStaging

protected AssetStaging(software.amazon.jsii.JsiiObjectRef objRef)

AssetStaging

protected AssetStaging(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AssetStaging

@Stability(value=Stable)
public AssetStaging(@NotNull
                                             Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             AssetStagingProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

synthesize

@Stability(value=Stable)
protected void synthesize(@NotNull
                                                   ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

Overrides:

synthesize in class Construct

Parameters:

session - This parameter is required.

getSourceHash

@Stability(value=Stable)
 @NotNull
public String getSourceHash()

A cryptographic hash of the source document(s).

getSourcePath

@Stability(value=Stable)
 @NotNull
public String getSourcePath()

The path of the asset as it was referenced by the user.

getStagedPath

@Stability(value=Stable)
 @NotNull
public String getStagedPath()

The path to the asset (stringinfied token).

If asset staging is disabled, this will just be the original path. If asset staging is enabled it will be the staged path.