Class AssetManifestArtifact
Asset manifest is a description of a set of assets which need to be built and published.
Inherited Members
Namespace: Amazon.CDK.CXAPI
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class AssetManifestArtifact : CloudArtifact
Syntax (vb)
Public Class AssetManifestArtifact
Inherits CloudArtifact
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.CloudAssembly.Schema;
using Amazon.CDK.CXAPI;
CloudAssembly cloudAssembly;
var assetManifestArtifact = new AssetManifestArtifact(cloudAssembly, "name", new ArtifactManifest {
Type = ArtifactType.NONE,
// the properties below are optional
Dependencies = new [] { "dependencies" },
DisplayName = "displayName",
Environment = "environment",
Metadata = new Dictionary<string, MetadataEntry[]> {
{ "metadataKey", new [] { new MetadataEntry {
Type = "type",
// the properties below are optional
Data = "data",
Trace = new [] { "trace" }
} } }
},
Properties = new AwsCloudFormationStackProperties {
TemplateFile = "templateFile",
// the properties below are optional
AssumeRoleArn = "assumeRoleArn",
AssumeRoleExternalId = "assumeRoleExternalId",
BootstrapStackVersionSsmParameter = "bootstrapStackVersionSsmParameter",
CloudFormationExecutionRoleArn = "cloudFormationExecutionRoleArn",
LookupRole = new BootstrapRole {
Arn = "arn",
// the properties below are optional
AssumeRoleExternalId = "assumeRoleExternalId",
BootstrapStackVersionSsmParameter = "bootstrapStackVersionSsmParameter",
RequiresBootstrapStackVersion = 123
},
Parameters = new Dictionary<string, string> {
{ "parametersKey", "parameters" }
},
RequiresBootstrapStackVersion = 123,
StackName = "stackName",
StackTemplateAssetObjectUrl = "stackTemplateAssetObjectUrl",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
TerminationProtection = false,
ValidateOnSynth = false
}
});
Synopsis
Constructors
AssetManifestArtifact(CloudAssembly, String, IArtifactManifest) | |
AssetManifestArtifact(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
AssetManifestArtifact(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
BootstrapStackVersionSsmParameter | Name of SSM parameter with bootstrap stack version. |
Contents | The Asset Manifest contents. |
File | The file name of the asset manifest. |
RequiresBootstrapStackVersion | Version of bootstrap stack required to deploy this stack. |
Methods
IsAssetManifestArtifact(Object) | Checks if |
Constructors
AssetManifestArtifact(CloudAssembly, String, IArtifactManifest)
public AssetManifestArtifact(CloudAssembly assembly, string name, IArtifactManifest artifact)
Parameters
- assembly CloudAssembly
- name System.String
- artifact IArtifactManifest
AssetManifestArtifact(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected AssetManifestArtifact(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
AssetManifestArtifact(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected AssetManifestArtifact(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
BootstrapStackVersionSsmParameter
Name of SSM parameter with bootstrap stack version.
public virtual string BootstrapStackVersionSsmParameter { get; }
Property Value
System.String
Remarks
Default: - Discover SSM parameter by reading stack
Contents
The Asset Manifest contents.
public virtual IAssetManifest Contents { get; }
Property Value
File
The file name of the asset manifest.
public virtual string File { get; }
Property Value
System.String
RequiresBootstrapStackVersion
Version of bootstrap stack required to deploy this stack.
public virtual Nullable<double> RequiresBootstrapStackVersion { get; }
Property Value
System.Nullable<System.Double>
Methods
IsAssetManifestArtifact(Object)
Checks if art
is an instance of this class.
public static bool IsAssetManifestArtifact(object art)
Parameters
- art System.Object
Returns
System.Boolean
Remarks
Use this method instead of instanceof
to properly detect AssetManifestArtifact
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the cx-api
library on
disk are seen as independent, completely different libraries. As a
consequence, the class AssetManifestArtifact
in each copy of the cx-api
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the cx-api
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.