Class FileAssetSource

Represents the source for a file asset.

Inheritance

System.Object

FileAssetSource

Implements

IFileAssetSource

Namespace: Amazon.CDK

Assembly: Amazon.CDK.dll

Syntax (csharp)

public class FileAssetSource : Object, IFileAssetSource

Syntax (vb)

Public Class FileAssetSource
    Inherits Object
    Implements IFileAssetSource

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
FileAssetSource fileAssetSource = new FileAssetSource {
    SourceHash = "sourceHash",

    // the properties below are optional
    Executable = new [] { "executable" },
    FileName = "fileName",
    Packaging = FileAssetPackaging.ZIP_DIRECTORY
};

Synopsis

Constructors

FileAssetSource()

Properties

Executable	An external command that will produce the packaged asset.
FileName	The path, relative to the root of the cloud assembly, in which this asset source resides.
Packaging	Which type of packaging to perform.
SourceHash	A hash on the content source.

Constructors

FileAssetSource()

public FileAssetSource()

Properties

Executable

An external command that will produce the packaged asset.

public string[] Executable { get; set; }

Property Value

System.String[]

Remarks

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

Default: - Exactly one of directory and executable is required

FileName

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

public string FileName { get; set; }

Property Value

System.String

Remarks

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

Default: - Exactly one of directory and executable is required

Packaging

Which type of packaging to perform.

public Nullable<FileAssetPackaging> Packaging { get; set; }

Property Value

System.Nullable<FileAssetPackaging>

Remarks

Default: - Required if fileName is specified.

SourceHash

A hash on the content source.

public string SourceHash { get; set; }

Property Value

System.String

Remarks

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.

Implements

IFileAssetSource