Package software.amazon.awscdk.pipelines

Interface StackAsset

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StackAsset.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:15.299Z")
@Stability(Stable)
public interface StackAsset
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.pipelines.*;
 StackAsset stackAsset = StackAsset.builder()
         .assetId("assetId")
         .assetManifestPath("assetManifestPath")
         .assetSelector("assetSelector")
         .assetType(AssetType.FILE)
         .isTemplate(false)
         // the properties below are optional
         .assetPublishingRoleArn("assetPublishingRoleArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	StackAsset.Builder	A builder for StackAsset
static final class	StackAsset.Jsii$Proxy	An implementation for StackAsset

Method Summary

Modifier and Type	Method	Description
static StackAsset.Builder	builder()
String	getAssetId()	Asset identifier.
String	getAssetManifestPath()	Absolute asset manifest path.
default String	getAssetPublishingRoleArn()	Role ARN to assume to publish.
String	getAssetSelector()	Asset selector to pass to cdk-assets.
AssetType	getAssetType()	Type of asset to publish.
Boolean	getIsTemplate()	Does this asset represent the CloudFormation template for the stack.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAssetId

@Stability(Stable)
@NotNull
String getAssetId()

Asset identifier.

getAssetManifestPath

@Stability(Stable)
@NotNull
String getAssetManifestPath()

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.

getAssetSelector

@Stability(Stable)
@NotNull
String getAssetSelector()

Asset selector to pass to cdk-assets.

getAssetType

@Stability(Stable)
@NotNull
AssetType getAssetType()

Type of asset to publish.

getIsTemplate

@Stability(Stable)
@NotNull
Boolean getIsTemplate()

Does this asset represent the CloudFormation template for the stack.

Default: false

getAssetPublishingRoleArn

@Stability(Stable)
@Nullable
default String getAssetPublishingRoleArn()

Role ARN to assume to publish.

Default: - No need to assume any role

builder

@Stability(Stable)
static StackAsset.Builder builder()

Returns:

a StackAsset.Builder of StackAsset