aws-cdk-lib.pipelines.StackAsset

interface StackAsset

LanguageType name
.NETAmazon.CDK.Pipelines.StackAsset
Gogithub.com/aws/aws-cdk-go/awscdk/v2/pipelines#StackAsset
Javasoftware.amazon.awscdk.pipelines.StackAsset
Pythonaws_cdk.pipelines.StackAsset
TypeScript (source)aws-cdk-lib » pipelines » StackAsset

An asset used by a Stack.

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',
};

Properties

NameTypeDescription
assetIdstringAsset identifier.
assetManifestPathstringAbsolute asset manifest path.
assetSelectorstringAsset selector to pass to cdk-assets.
assetTypeAssetTypeType of asset to publish.
isTemplatebooleanDoes this asset represent the CloudFormation template for the stack.
assetPublishingRoleArn?stringRole ARN to assume to publish.

assetId

Type: string

Asset identifier.


assetManifestPath

Type: string

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.


assetSelector

Type: string

Asset selector to pass to cdk-assets.


assetType

Type: AssetType

Type of asset to publish.


isTemplate

Type: boolean

Does this asset represent the CloudFormation template for the stack.


assetPublishingRoleArn?

Type: string (optional, default: No need to assume any role)

Role ARN to assume to publish.