Class: AWSCDK::CXAPI::CloudArtifact

Inherits:
Jsii::Object
  • Object
show all
Defined in:
cxapi/cloud_artifact.rb

Overview

Represents an artifact within a cloud assembly.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(assembly, id, manifest) ⇒ CloudArtifact

Returns a new instance of CloudArtifact.

Parameters:



11
12
13
14
15
16
17
 
# File 'cxapi/cloud_artifact.rb', line 11

def initialize(assembly, id, manifest)
  manifest = manifest.is_a?(Hash) ? ::AWSCDK::CloudAssemblySchema::ArtifactManifest.new(**manifest.transform_keys(&:to_sym)) : manifest
  Jsii::Type.check_type(assembly, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jeF9hcGkuQ2xvdWRBc3NlbWJseSJ9")), "assembly")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(manifest, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jbG91ZF9hc3NlbWJseV9zY2hlbWEuQXJ0aWZhY3RNYW5pZmVzdCJ9")), "manifest")
  Jsii::Object.instance_method(:initialize).bind(self).call(assembly, id, manifest)
end

Class Method Details

.from_manifest(assembly, id, artifact) ⇒ AWSCDK::CXAPI::CloudArtifact?

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

Parameters:

Returns:

  • (AWSCDK::CXAPI::CloudArtifact, nil) —

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



38
39
40
41
42
43
44
 
# File 'cxapi/cloud_artifact.rb', line 38

def self.from_manifest(assembly, id, artifact)
  Jsii::Type.check_type(assembly, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jeF9hcGkuQ2xvdWRBc3NlbWJseSJ9")), "assembly")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  artifact = artifact.is_a?(Hash) ? ::AWSCDK::CloudAssemblySchema::ArtifactManifest.new(**artifact.transform_keys(&:to_sym)) : artifact
  Jsii::Type.check_type(artifact, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jbG91ZF9hc3NlbWJseV9zY2hlbWEuQXJ0aWZhY3RNYW5pZmVzdCJ9")), "artifact")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.cx_api.CloudArtifact", "fromManifest", [assembly, id, artifact])
end

.jsii_overridable_methods ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'cxapi/cloud_artifact.rb', line 19

def self.jsii_overridable_methods
  {
    :assembly => { kind: :property, name: "assembly", is_optional: false },
    :dependencies => { kind: :property, name: "dependencies", is_optional: false },
    :hierarchical_id => { kind: :property, name: "hierarchicalId", is_optional: false },
    :id => { kind: :property, name: "id", is_optional: false },
    :manifest => { kind: :property, name: "manifest", is_optional: false },
    :messages => { kind: :property, name: "messages", is_optional: false },
    :metadata => { kind: :property, name: "metadata", is_optional: false },
    :find_metadata_by_type => { kind: :method, name: "findMetadataByType", is_optional: false },
  }
end

Instance Method Details

#assembly ⇒ AWSCDK::CXAPI::CloudAssembly

Returns:



47
48
49
 
# File 'cxapi/cloud_artifact.rb', line 47

def assembly()
  jsii_get_property("assembly")
end

#dependencies ⇒ Array<AWSCDK::CXAPI::CloudArtifact>

Returns all the artifacts that this artifact depends on.

Returns:

  • (Array<AWSCDK::CXAPI::CloudArtifact>) 


54
55
56
 
# File 'cxapi/cloud_artifact.rb', line 54

def dependencies()
  jsii_get_property("dependencies")
end

#find_metadata_by_type(type) ⇒ Array<AWSCDK::CXAPI::MetadataEntryResult>

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

Parameters:

  • type (String)

Returns:



96
97
98
99
 
# File 'cxapi/cloud_artifact.rb', line 96

def find_metadata_by_type(type)
  Jsii::Type.check_type(type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  jsii_call_method("findMetadataByType", [type])
end

#hierarchical_id ⇒ 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.

Returns:

  • (String) 


64
65
66
 
# File 'cxapi/cloud_artifact.rb', line 64

def hierarchical_id()
  jsii_get_property("hierarchicalId")
end

#id ⇒ String

Returns:

  • (String) 


69
70
71
 
# File 'cxapi/cloud_artifact.rb', line 69

def id()
  jsii_get_property("id")
end

#manifest ⇒ AWSCDK::CloudAssemblySchema::ArtifactManifest

The artifact's manifest.

Returns:



76
77
78
 
# File 'cxapi/cloud_artifact.rb', line 76

def manifest()
  jsii_get_property("manifest")
end

#messages ⇒ Array<AWSCDK::CXAPI::SynthesisMessage>

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

Returns:



83
84
85
 
# File 'cxapi/cloud_artifact.rb', line 83

def messages()
  jsii_get_property("messages")
end

#metadata ⇒ Hash{String => Array<AWSCDK::CloudAssemblySchema::MetadataEntry>}

Returns the metadata associated with this Cloud Artifact.

Returns:



90
91
92
 
# File 'cxapi/cloud_artifact.rb', line 90

def metadata()
  jsii_get_property("metadata")
end