Module: AWSCDK::CloudAssemblySchema::ICloudAssembly

Included in:
AWSCDK::CXAPI::CloudAssembly
Defined in:
cloud_assembly_schema/i_cloud_assembly.rb

Overview

Interoperable representation of a deployable cloud application.

The external and interoperable contract for a Cloud Assembly is a directory containing a valid Cloud Assembly.

Implementations should use the directory to load the Cloud Assembly from disk. It is recommended that implementations validate loaded manifest files using the provided functionality from this package. Within an implementation, it may be prudent to keep (parts of) the Cloud Assembly in memory during execution and use an implementation-specific contract. However when an implementation is providing an external contract, this interface should be used.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methodsObject



28
29
30
31
32
# File 'cloud_assembly_schema/i_cloud_assembly.rb', line 28

def self.jsii_overridable_methods
  {
    :directory => { kind: :property, name: "directory", is_optional: false },
  }
end

Instance Method Details

#directoryString

The directory of the cloud assembly.

This directory will be used to read the Cloud Assembly from. Its contents (in particular manifest.json) must comply with the schema defined in this package.

Returns:

  • (String)


24
25
26
# File 'cloud_assembly_schema/i_cloud_assembly.rb', line 24

def directory()
  jsii_get_property("directory")
end