Skip to content

FileAssetSource

Represents the source for a file asset.

Initializer 

import { FileAssetSource } from '@alicloud/ros-cdk-core'
const fileAssetSource: FileAssetSource = { ... }

Properties

Name Type Description
sourceHash string A hash on the content source.
deployTime boolean Whether or not the asset needs to exist beyond deployment time;
executable string[] An external command that will produce the packaged asset.
fileName string The path, relative to the root of the cloud assembly, in which this asset source resides.
packaging FileAssetPackaging Which type of packaging to perform.

sourceHashRequired 

public readonly sourceHash: string;
  • Type: string

A hash on the content source.

This hash is used to uniquely identify this asset throughout the system. If this value doesn't change, the asset will not be rebuilt or republished.

deployTimeOptional 

public readonly deployTime: boolean;
  • Type: boolean
  • Default: false

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 ROS deployment succeeds.

For example, FC Function assets are copied over to FC during deployment. Therefore, it is not necessary to store the asset in OSS bucket, so we consider those deployTime assets.

executableOptional 

public readonly executable: string[];
  • Type: string[]
  • Default: Exactly one of fileName and executable is required

An external command that will produce the packaged asset.

The command should produce the location of a ZIP file on stdout.

fileNameOptional 

public readonly fileName: string;
  • Type: string
  • Default: Exactly one of fileName and executable is required

The path, relative to the root of the cloud assembly, in which this asset source resides.

This can be a path to a file or a directory, depending on the packaging type.

packagingOptional 

public readonly packaging: FileAssetPackaging;

Which type of packaging to perform.