Class: AWSCDK::CloudAssemblySchema::AssemblyManifest

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

Overview

A manifest which describes the cloud assembly.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(version:, artifacts: nil, minimum_cli_version: nil, missing: nil, runtime: nil) ⇒ AssemblyManifest

Returns a new instance of AssemblyManifest.

Parameters:



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'cloud_assembly_schema/assembly_manifest.rb', line 12

def initialize(version:, artifacts: nil, minimum_cli_version: nil, missing: nil, runtime: nil)
  @version = version
  Jsii::Type.check_type(@version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version")
  @artifacts = artifacts.is_a?(Hash) ? artifacts.transform_values { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CloudAssemblySchema::ArtifactManifest.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : artifacts
  Jsii::Type.check_type(@artifacts, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmNsb3VkX2Fzc2VtYmx5X3NjaGVtYS5BcnRpZmFjdE1hbmlmZXN0In0sImtpbmQiOiJtYXAifX0=")), "artifacts") unless @artifacts.nil?
  @minimum_cli_version = minimum_cli_version
  Jsii::Type.check_type(@minimum_cli_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "minimumCliVersion") unless @minimum_cli_version.nil?
  @missing = missing.is_a?(Array) ? missing.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CloudAssemblySchema::MissingContext.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : missing
  Jsii::Type.check_type(@missing, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmNsb3VkX2Fzc2VtYmx5X3NjaGVtYS5NaXNzaW5nQ29udGV4dCJ9LCJraW5kIjoiYXJyYXkifX0=")), "missing") unless @missing.nil?
  @runtime = runtime.is_a?(Hash) ? ::AWSCDK::CloudAssemblySchema::RuntimeInfo.new(**runtime.transform_keys(&:to_sym)) : runtime
  Jsii::Type.check_type(@runtime, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jbG91ZF9hc3NlbWJseV9zY2hlbWEuUnVudGltZUluZm8ifQ==")), "runtime") unless @runtime.nil?
end

Instance Attribute Details

#artifacts ⇒ Hash{String => AWSCDK::CloudAssemblySchema::ArtifactManifest}? (readonly)

Note:

Default: - no artifacts.

The set of artifacts in this assembly.

Returns:



33
34
35
 
# File 'cloud_assembly_schema/assembly_manifest.rb', line 33

def artifacts
  @artifacts
end

#minimum_cli_version ⇒ String? (readonly)

Note:

Default: - Minimum CLI version unknown

Required CLI version, if available.

If the manifest producer knows, it can put the minimum version of the CLI here that supports reading this assembly.

If set, it can be used to show a more informative error message to users.

Returns:

  • (String, nil) 


43
44
45
 
# File 'cloud_assembly_schema/assembly_manifest.rb', line 43

def minimum_cli_version
  @minimum_cli_version
end

#missing ⇒ Array<AWSCDK::CloudAssemblySchema::MissingContext>? (readonly)

Note:

Default: - no missing context.

Missing context information.

If this field has values, it means that the cloud assembly is not complete and should not be deployed.

Returns:



51
52
53
 
# File 'cloud_assembly_schema/assembly_manifest.rb', line 51

def missing
  @missing
end

#runtime ⇒ AWSCDK::CloudAssemblySchema::RuntimeInfo? (readonly)

Note:

Default: - no info.

Runtime information.

Returns:



56
57
58
 
# File 'cloud_assembly_schema/assembly_manifest.rb', line 56

def runtime
  @runtime
end

#version ⇒ String (readonly)

Protocol version.

Returns:

  • (String) 


28
29
30
 
# File 'cloud_assembly_schema/assembly_manifest.rb', line 28

def version
  @version
end

Class Method Details

.jsii_properties ⇒ Object 



58
59
60
61
62
63
64
65
66
 
# File 'cloud_assembly_schema/assembly_manifest.rb', line 58

def self.jsii_properties
  {
    :version => "version",
    :artifacts => "artifacts",
    :minimum_cli_version => "minimumCliVersion",
    :missing => "missing",
    :runtime => "runtime",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
 
# File 'cloud_assembly_schema/assembly_manifest.rb', line 68

def to_jsii
  result = {}
  result.merge!({
    "version" => @version,
    "artifacts" => @artifacts,
    "minimumCliVersion" => @minimum_cli_version,
    "missing" => @missing,
    "runtime" => @runtime,
  })
  result.compact
end