class NestedCloudAssemblyArtifact

Language	Type name
.NET	Amazon.CDK.CXAPI.NestedCloudAssemblyArtifact
Java	software.amazon.awscdk.cxapi.NestedCloudAssemblyArtifact
Python	aws_cdk.cx_api.NestedCloudAssemblyArtifact
TypeScript (source)	@aws-cdk/cx-api » NestedCloudAssemblyArtifact

Extends CloudArtifact

Asset manifest is a description of a set of assets which need to be built and published.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';
import * as cx_api from '@aws-cdk/cx-api';

declare const cloudAssembly: cx_api.CloudAssembly;
const nestedCloudAssemblyArtifact = new cx_api.NestedCloudAssemblyArtifact(cloudAssembly, 'name', {
  type: cloud_assembly_schema.ArtifactType.NONE,

  // the properties below are optional
  dependencies: ['dependencies'],
  displayName: 'displayName',
  environment: 'environment',
  metadata: {
    metadataKey: [{
      type: 'type',

      // the properties below are optional
      data: 'data',
      trace: ['trace'],
    }],
  },
  properties: {
    templateFile: 'templateFile',

    // the properties below are optional
    assumeRoleArn: 'assumeRoleArn',
    assumeRoleExternalId: 'assumeRoleExternalId',
    bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',
    cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',
    lookupRole: {
      arn: 'arn',

      // the properties below are optional
      assumeRoleExternalId: 'assumeRoleExternalId',
      bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',
      requiresBootstrapStackVersion: 123,
    },
    parameters: {
      parametersKey: 'parameters',
    },
    requiresBootstrapStackVersion: 123,
    stackName: 'stackName',
    stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',
    tags: {
      tagsKey: 'tags',
    },
    terminationProtection: false,
    validateOnSynth: false,
  },
});

Initializer

new NestedCloudAssemblyArtifact(assembly: CloudAssembly, name: string, artifact: ArtifactManifest)

Parameters

• assembly CloudAssembly
• name string
• artifact ArtifactManifest

Properties

Name	Type	Description
assembly	CloudAssembly
dependencies	CloudArtifact[]	Returns all the artifacts that this artifact depends on.
directoryName	string	The relative directory name of the asset manifest.
displayName	string	Display name.
fullPath	string	Full path to the nested assembly directory.
hierarchicalId	string	An identifier that shows where this artifact is located in the tree of nested assemblies, based on their manifests.
id	string
manifest	ArtifactManifest	The artifact's manifest.
messages	SynthesisMessage[]	The set of messages extracted from the artifact's metadata.
nestedAssembly	CloudAssembly	The nested Assembly.

---

assembly

Type: CloudAssembly

---

dependencies

Type: CloudArtifact[]

Returns all the artifacts that this artifact depends on.

---

directoryName

Type: string

The relative directory name of the asset manifest.

---

displayName

Type: string

Display name.

---

fullPath

Type: string

Full path to the nested assembly directory.

---

hierarchicalId

Type: string

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

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

---

id

Type: string

---

manifest

Type: ArtifactManifest

The artifact's manifest.

---

messages

Type: SynthesisMessage[]

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

---

nestedAssembly

Type: CloudAssembly

The nested Assembly.

Methods

Name	Description
findMetadataByType(type)

---

findMetadataByType(type)

public findMetadataByType(type: string): MetadataEntryResult[]

Parameters

• type string

Returns

• MetadataEntryResult[]