Asset

An asset represents a local file or directory, which is automatically uploaded to OSS bucket and then can be referenced within a CDK application.

Initializers

import { Asset } from '@alicloud/ros-cdk-ossassets'
new Asset(scope: Construct, id: string, props: AssetProps)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	AssetProps	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: AssetProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.
addResourceMetadata	Adds ROS template metadata to the specified resource with information that indicates which resource property is mapped to this local asset.

---

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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.

session^Required

• Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

addResourceMetadata

public addResourceMetadata(resource: RosResource, resourceProperty: string): void

Adds ROS template metadata to the specified resource with information that indicates which resource property is mapped to this local asset.

Asset metadata will only be included if the stack is synthesized with the "ros:cdk:enable-asset-metadata" context key defined, which is the default behavior when synthesizing via the CDK Toolkit.

resource^Required

• Type: @alicloud/ros-cdk-core.RosResource

The ROS resource which is using this asset.

---

resourceProperty^Required

• Type: string

The property name where this asset is referenced.

---

Static Functions

Name	Description
isConstruct	Return whether the given object is a Construct.

---

isConstruct

import { Asset } from '@alicloud/ros-cdk-ossassets'
Asset.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
ref	string	No description.
stack	@alicloud/ros-cdk-core.Stack	The stack in which this resource is defined.
resource	@alicloud/ros-cdk-core.RosResource	No description.
assetHash	string	A cryptographic hash of the asset.
assetPath	string	The path to the asset, relative to the current Cloud Assembly.
bucketName	string	Attribute that represents the name of the OSS bucket this asset exists in.
httpUrl	string	Attribute which represents the OSS HTTP URL of this asset.
isFile	boolean	Indicates if this asset is a single file.
isZipArchive	boolean	Indicates if this asset is a zip archive.
objectKey	string	Attribute which represents the OSS object key of this asset.

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

assetHash^Required

public readonly assetHash: string;

• Type: string

A cryptographic hash of the asset.

---

assetPath^Required

public readonly assetPath: string;

• Type: string

The path to the asset, relative to the current Cloud Assembly.

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

---

bucketName^Required

public readonly bucketName: string;

• Type: string

Attribute that represents the name of the OSS bucket this asset exists in.

---

httpUrl^Required

public readonly httpUrl: string;

• Type: string

Attribute which represents the OSS HTTP URL of this asset.

For example, https://${bucketName}.oss-${region}.aliyuncs.com/${objectKey}

---

isFile^Required

public readonly isFile: boolean;

• Type: boolean

Indicates if this asset is a single file.

Allows constructs to ensure that the correct file type was used.

---

isZipArchive^Required

public readonly isZipArchive: boolean;

• Type: boolean

Indicates if this asset is a zip archive.

Allows constructs to ensure that the correct file type was used.

---

objectKey^Required

public readonly objectKey: string;

• Type: string

Attribute which represents the OSS object key of this asset.

---

Structs