Class: AWSCDK::CloudAssemblySchema::Manifest

Inherits:
Jsii::Object
  • Object
show all
Defined in:
cloud_assembly_schema/manifest.rb

Overview

Protocol utility class.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeManifest

Returns a new instance of Manifest.



8
9
10
# File 'cloud_assembly_schema/manifest.rb', line 8

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.cli_versionString?

Return the CLI version that supports this Cloud Assembly Schema version.

Returns:

  • (String, nil)


20
21
22
# File 'cloud_assembly_schema/manifest.rb', line 20

def self.cli_version()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.cloud_assembly_schema.Manifest", "cliVersion", [])
end

.jsii_overridable_methodsObject



12
13
14
15
# File 'cloud_assembly_schema/manifest.rb', line 12

def self.jsii_overridable_methods
  {
  }
end

.load_assembly_manifest(file_path, options = nil) ⇒ AWSCDK::CloudAssemblySchema::AssemblyManifest

Load and validates the cloud assembly manifest from file.

Parameters:

Returns:



29
30
31
32
33
34
# File 'cloud_assembly_schema/manifest.rb', line 29

def self.load_assembly_manifest(file_path, options = nil)
  Jsii::Type.check_type(file_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filePath")
  options = options.is_a?(Hash) ? ::AWSCDK::CloudAssemblySchema::LoadManifestOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jbG91ZF9hc3NlbWJseV9zY2hlbWEuTG9hZE1hbmlmZXN0T3B0aW9ucyJ9")), "options") unless options.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.cloud_assembly_schema.Manifest", "loadAssemblyManifest", [file_path, options])
end

.load_asset_manifest(file_path) ⇒ AWSCDK::CloudAssemblySchema::AssetManifest

Load and validates the asset manifest from file.

Parameters:

  • file_path (String)
    • path to the manifest file.

Returns:



40
41
42
43
# File 'cloud_assembly_schema/manifest.rb', line 40

def self.load_asset_manifest(file_path)
  Jsii::Type.check_type(file_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filePath")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.cloud_assembly_schema.Manifest", "loadAssetManifest", [file_path])
end

.load_integ_manifest(file_path) ⇒ AWSCDK::CloudAssemblySchema::IntegManifest

Load and validates the integ manifest from file.

Parameters:

  • file_path (String)
    • path to the manifest file.

Returns:



49
50
51
52
# File 'cloud_assembly_schema/manifest.rb', line 49

def self.load_integ_manifest(file_path)
  Jsii::Type.check_type(file_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filePath")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.cloud_assembly_schema.Manifest", "loadIntegManifest", [file_path])
end

.load_validation_report(file_path) ⇒ AWSCDK::CloudAssemblySchema::PolicyValidationReportJson

Load and validate the policy validation report from file.

Parameters:

  • file_path (String)
    • path to the validation report file.

Returns:



58
59
60
61
# File 'cloud_assembly_schema/manifest.rb', line 58

def self.load_validation_report(file_path)
  Jsii::Type.check_type(file_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filePath")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.cloud_assembly_schema.Manifest", "loadValidationReport", [file_path])
end

.save_assembly_manifest(manifest, file_path) ⇒ void

This method returns an undefined value.

Validates and saves the cloud assembly manifest to file.

Parameters:



68
69
70
71
72
73
# File 'cloud_assembly_schema/manifest.rb', line 68

def self.save_assembly_manifest(manifest, file_path)
  manifest = manifest.is_a?(Hash) ? ::AWSCDK::CloudAssemblySchema::AssemblyManifest.new(**manifest.transform_keys(&:to_sym)) : manifest
  Jsii::Type.check_type(manifest, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jbG91ZF9hc3NlbWJseV9zY2hlbWEuQXNzZW1ibHlNYW5pZmVzdCJ9")), "manifest")
  Jsii::Type.check_type(file_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filePath")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.cloud_assembly_schema.Manifest", "saveAssemblyManifest", [manifest, file_path])
end

.save_asset_manifest(manifest, file_path) ⇒ void

This method returns an undefined value.

Validates and saves the asset manifest to file.

Parameters:



80
81
82
83
84
85
# File 'cloud_assembly_schema/manifest.rb', line 80

def self.save_asset_manifest(manifest, file_path)
  manifest = manifest.is_a?(Hash) ? ::AWSCDK::CloudAssemblySchema::AssetManifest.new(**manifest.transform_keys(&:to_sym)) : manifest
  Jsii::Type.check_type(manifest, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jbG91ZF9hc3NlbWJseV9zY2hlbWEuQXNzZXRNYW5pZmVzdCJ9")), "manifest")
  Jsii::Type.check_type(file_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filePath")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.cloud_assembly_schema.Manifest", "saveAssetManifest", [manifest, file_path])
end

.save_integ_manifest(manifest, file_path) ⇒ void

This method returns an undefined value.

Validates and saves the integ manifest to file.

Parameters:



92
93
94
95
96
97
# File 'cloud_assembly_schema/manifest.rb', line 92

def self.save_integ_manifest(manifest, file_path)
  manifest = manifest.is_a?(Hash) ? ::AWSCDK::CloudAssemblySchema::IntegManifest.new(**manifest.transform_keys(&:to_sym)) : manifest
  Jsii::Type.check_type(manifest, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jbG91ZF9hc3NlbWJseV9zY2hlbWEuSW50ZWdNYW5pZmVzdCJ9")), "manifest")
  Jsii::Type.check_type(file_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filePath")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.cloud_assembly_schema.Manifest", "saveIntegManifest", [manifest, file_path])
end

.versionString

Fetch the current schema version number.

Returns:

  • (String)


102
103
104
# File 'cloud_assembly_schema/manifest.rb', line 102

def self.version()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.cloud_assembly_schema.Manifest", "version", [])
end