Class CloudArtifact

Represents an artifact within a cloud assembly.

Inheritance

System.Object

CloudArtifact

AssetManifestArtifact

CloudFormationStackArtifact

NestedCloudAssemblyArtifact

TreeCloudArtifact

Namespace: Amazon.CDK.CXAPI

Assembly: Amazon.CDK.CXAPI.dll

Syntax (csharp)

public class CloudArtifact : DeputyBase

Syntax (vb)

Public Class CloudArtifact
    Inherits DeputyBase

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;

CloudArtifact? cloudArtifact = CloudArtifact.FromManifest(cloudAssembly, "MyCloudArtifact", 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

CloudArtifact(CloudAssembly, String, IArtifactManifest)
CloudArtifact(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CloudArtifact(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

Assembly
Dependencies	Returns all the artifacts that this artifact depends on.
HierarchicalId	An identifier that shows where this artifact is located in the tree of nested assemblies, based on their manifests.
Id
Manifest	The artifact's manifest.
Messages	The set of messages extracted from the artifact's metadata.

Methods

FindMetadataByType(String)
FromManifest(CloudAssembly, String, IArtifactManifest)	Returns a subclass of `CloudArtifact` based on the artifact type defined in the artifact manifest.

Constructors

CloudArtifact(CloudAssembly, String, IArtifactManifest)

public CloudArtifact(CloudAssembly assembly, string id, IArtifactManifest manifest)

Parameters

assembly CloudAssembly
id System.String
manifest IArtifactManifest

CloudArtifact(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CloudArtifact(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CloudArtifact(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CloudArtifact(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Properties

Assembly

public virtual CloudAssembly Assembly { get; }

Property Value

CloudAssembly

Dependencies

Returns all the artifacts that this artifact depends on.

public virtual CloudArtifact[] Dependencies { get; }

Property Value

CloudArtifact[]

HierarchicalId

An identifier that shows where this artifact is located in the tree of nested assemblies, based on their manifests.

public virtual string HierarchicalId { get; }

Property Value

System.String

Remarks

Defaults to the normal id. Should only be used in user interfaces.

Id

public virtual string Id { get; }

Property Value

System.String

Manifest

The artifact's manifest.

public virtual IArtifactManifest Manifest { get; }

Property Value

IArtifactManifest

Messages

The set of messages extracted from the artifact's metadata.

public virtual ISynthesisMessage[] Messages { get; }

Property Value

ISynthesisMessage[]

Methods

FindMetadataByType(String)

public virtual IMetadataEntryResult[] FindMetadataByType(string type)

Parameters

type System.String

Returns

IMetadataEntryResult[]

all the metadata entries of a specific type in this artifact.

FromManifest(CloudAssembly, String, IArtifactManifest)

Returns a subclass of CloudArtifact based on the artifact type defined in the artifact manifest.

public static CloudArtifact FromManifest(CloudAssembly assembly, string id, IArtifactManifest artifact)

Parameters

assembly CloudAssembly: The cloud assembly from which to load the artifact.
id System.String: The artifact ID.
artifact IArtifactManifest: The artifact manifest.

Returns

CloudArtifact

the CloudArtifact that matches the artifact type or undefined if it's an artifact type that is unrecognized by this module.