Class: AWSCDK::CXAPI::CloudAssemblyBuilder

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

Overview

Can be used to build a cloud assembly.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(outdir = nil, props = nil) ⇒ CloudAssemblyBuilder

Initializes a cloud assembly builder.

Parameters:



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

def initialize(outdir = nil, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CXAPI::CloudAssemblyBuilderProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(outdir, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outdir") unless outdir.nil?
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jeF9hcGkuQ2xvdWRBc3NlbWJseUJ1aWxkZXJQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(outdir, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



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

def self.jsii_overridable_methods
  {
    :asset_outdir => { kind: :property, name: "assetOutdir", is_optional: false },
    :outdir => { kind: :property, name: "outdir", is_optional: false },
    :add_artifact => { kind: :method, name: "addArtifact", is_optional: false },
    :add_missing => { kind: :method, name: "addMissing", is_optional: false },
    :build_assembly => { kind: :method, name: "buildAssembly", is_optional: false },
    :create_nested_assembly => { kind: :method, name: "createNestedAssembly", is_optional: false },
    :delete => { kind: :method, name: "delete", is_optional: false },
  }
end

Instance Method Details

#add_artifact(id, manifest) ⇒ void

This method returns an undefined value.

Adds an artifact into the cloud assembly.

Parameters:



50
51
52
53
54
55
 
# File 'cxapi/cloud_assembly_builder.rb', line 50

def add_artifact(id, manifest)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  manifest = manifest.is_a?(Hash) ? ::AWSCDK::CloudAssemblySchema::ArtifactManifest.new(**manifest.transform_keys(&:to_sym)) : manifest
  Jsii::Type.check_type(manifest, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jbG91ZF9hc3NlbWJseV9zY2hlbWEuQXJ0aWZhY3RNYW5pZmVzdCJ9")), "manifest")
  jsii_call_method("addArtifact", [id, manifest])
end

#add_missing(missing) ⇒ void

This method returns an undefined value.

Reports that some context is missing in order for this cloud assembly to be fully synthesized.

Parameters:



61
62
63
64
65
 
# File 'cxapi/cloud_assembly_builder.rb', line 61

def add_missing(missing)
  missing = missing.is_a?(Hash) ? ::AWSCDK::CloudAssemblySchema::MissingContext.new(**missing.transform_keys(&:to_sym)) : missing
  Jsii::Type.check_type(missing, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jbG91ZF9hc3NlbWJseV9zY2hlbWEuTWlzc2luZ0NvbnRleHQifQ==")), "missing")
  jsii_call_method("addMissing", [missing])
end

#asset_outdir ⇒ String

The directory where assets of this Cloud Assembly should be stored.

Returns:

  • (String) 


34
35
36
 
# File 'cxapi/cloud_assembly_builder.rb', line 34

def asset_outdir()
  jsii_get_property("assetOutdir")
end

#build_assembly(options = nil) ⇒ AWSCDK::CXAPI::CloudAssembly

Finalizes the cloud assembly into the output directory returns a CloudAssembly object that can be used to inspect the assembly.

Parameters:

Returns:



71
72
73
74
75
 
# File 'cxapi/cloud_assembly_builder.rb', line 71

def build_assembly(options = nil)
  options = options.is_a?(Hash) ? ::AWSCDK::CXAPI::AssemblyBuildOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jeF9hcGkuQXNzZW1ibHlCdWlsZE9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("buildAssembly", [options])
end

#create_nested_assembly(artifact_id, display_name) ⇒ AWSCDK::CXAPI::CloudAssemblyBuilder

Creates a nested cloud assembly.

Parameters:

  • artifact_id (String)
  • display_name (String)

Returns:

  • (AWSCDK::CXAPI::CloudAssemblyBuilder) 


82
83
84
85
86
 
# File 'cxapi/cloud_assembly_builder.rb', line 82

def create_nested_assembly(artifact_id, display_name)
  Jsii::Type.check_type(artifact_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "artifactId")
  Jsii::Type.check_type(display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName")
  jsii_call_method("createNestedAssembly", [artifact_id, display_name])
end

#delete ⇒ void

This method returns an undefined value.

Delete the cloud assembly directory.



91
92
93
 
# File 'cxapi/cloud_assembly_builder.rb', line 91

def delete()
  jsii_call_method("delete", [])
end

#outdir ⇒ String

The root directory of the resulting cloud assembly.

Returns:

  • (String) 


41
42
43
 
# File 'cxapi/cloud_assembly_builder.rb', line 41

def outdir()
  jsii_get_property("outdir")
end