Class StackAsset

An asset used by a Stack.

Inheritance

object

StackAsset

Implements

IStackAsset

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Pipelines

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class StackAsset : IStackAsset

Syntax (vb)

Public Class StackAsset Implements IStackAsset

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.Pipelines;

            var stackAsset = new StackAsset {
                AssetId = "assetId",
                AssetManifestPath = "assetManifestPath",
                AssetSelector = "assetSelector",
                AssetType = AssetType.FILE,
                IsTemplate = false,

                // the properties below are optional
                AssetPublishingRoleArn = "assetPublishingRoleArn",
                DisplayName = "displayName"
            };

Synopsis

Constructors

StackAsset()

An asset used by a Stack.

Properties

AssetId	Asset identifier.
AssetManifestPath	Absolute asset manifest path.
AssetPublishingRoleArn	Role ARN to assume to publish.
AssetSelector	Asset selector to pass to `cdk-assets`.
AssetType	Type of asset to publish.
DisplayName	The display name of this asset.
IsTemplate	Does this asset represent the CloudFormation template for the stack.

Constructors

StackAsset()

An asset used by a Stack.

public StackAsset()

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.Pipelines;

            var stackAsset = new StackAsset {
                AssetId = "assetId",
                AssetManifestPath = "assetManifestPath",
                AssetSelector = "assetSelector",
                AssetType = AssetType.FILE,
                IsTemplate = false,

                // the properties below are optional
                AssetPublishingRoleArn = "assetPublishingRoleArn",
                DisplayName = "displayName"
            };

Properties

AssetId

Asset identifier.

public string AssetId { get; set; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

AssetManifestPath

Absolute asset manifest path.

public string AssetManifestPath { get; set; }

Property Value

string

Remarks

This needs to be made relative at a later point in time, but when this information is parsed we don't know about the root cloud assembly yet.

AssetPublishingRoleArn

Role ARN to assume to publish.

public string? AssetPublishingRoleArn { get; set; }

Property Value

string

Remarks

Default: - No need to assume any role

AssetSelector

Asset selector to pass to cdk-assets.

public string AssetSelector { get; set; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

AssetType

Type of asset to publish.

public AssetType AssetType { get; set; }

Property Value

AssetType

Remarks

ExampleMetadata: fixture=_generated

DisplayName

The display name of this asset.

public string? DisplayName { get; set; }

Property Value

string

Remarks

Default: - Use some generated string as display name

IsTemplate

Does this asset represent the CloudFormation template for the stack.

public bool IsTemplate { get; set; }

Property Value

bool

Remarks

Default: false

Implements

IStackAsset