aws-cdk-lib.pipelines.StackAsset

StackAsset Struct

An asset used by a Stack.

Source

pipelines/lib/blueprint/stack-deployment.ts

Type last changed

v2.187.0 · 31 Mar 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { pipelines } from 'aws-cdk-lib';
const stackAsset: pipelines.StackAsset = {
  assetId: 'assetId',
  assetManifestPath: 'assetManifestPath',
  assetSelector: 'assetSelector',
  assetType: pipelines.AssetType.FILE,
  isTemplate: false,

  // the properties below are optional
  assetPublishingRoleArn: 'assetPublishingRoleArn',
  displayName: 'displayName',
};

Properties

assetIdstringasset_idstrassetIdStringAssetIdstringAssetId*stringrequired#

Asset identifier.

assetManifestPathstringasset_manifest_pathstrassetManifestPathStringAssetManifestPathstringAssetManifestPath*stringrequired#

Absolute asset manifest path.

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.

assetPublishingRoleArnstringasset_publishing_role_arnstrassetPublishingRoleArnStringAssetPublishingRoleArnstringAssetPublishingRoleArn*string= No need to assume any role#

Role ARN to assume to publish.

assetSelectorstringasset_selectorstrassetSelectorStringAssetSelectorstringAssetSelector*stringrequired#

Asset selector to pass to `cdk-assets`.

assetTypeAssetTypeasset_typeAssetTypeassetTypeAssetTypeAssetTypeAssetTypeAssetTypeAssetTyperequired#

Type of asset to publish.

displayNamestringdisplay_namestrdisplayNameStringDisplayNamestringDisplayName*string= Use some generated string as dis…#

The display name of this asset.

default

Default: Use some generated string as display name

isTemplatebooleanis_templateboolisTemplateBooleanIsTemplateboolIsTemplate*bool= falserequired#

Does this asset represent the CloudFormation template for the stack.