Class: AWSCDK::CloudAssemblySchema::LoadManifestOptions

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

Overview

Options for the loadManifest operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(skip_enum_check: nil, skip_version_check: nil, topo_sort: nil, validate_schema: nil) ⇒ LoadManifestOptions

Returns a new instance of LoadManifestOptions.

Parameters:

  • skip_enum_check (Boolean, nil) (defaults to: nil) —

    Skip enum checks.

  • skip_version_check (Boolean, nil) (defaults to: nil) —

    Skip the version check.

  • topo_sort (Boolean, nil) (defaults to: nil) —

    Topologically sort all artifacts.

  • validate_schema (Boolean, nil) (defaults to: nil) —

    Validate the file according to the declared JSON Schema.



11
12
13
14
15
16
17
18
19
20
 
# File 'cloud_assembly_schema/load_manifest_options.rb', line 11

def initialize(skip_enum_check: nil, skip_version_check: nil, topo_sort: nil, validate_schema: nil)
  @skip_enum_check = skip_enum_check
  Jsii::Type.check_type(@skip_enum_check, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "skipEnumCheck") unless @skip_enum_check.nil?
  @skip_version_check = skip_version_check
  Jsii::Type.check_type(@skip_version_check, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "skipVersionCheck") unless @skip_version_check.nil?
  @topo_sort = topo_sort
  Jsii::Type.check_type(@topo_sort, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "topoSort") unless @topo_sort.nil?
  @validate_schema = validate_schema
  Jsii::Type.check_type(@validate_schema, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "validateSchema") unless @validate_schema.nil?
end

Instance Attribute Details

#skip_enum_check ⇒ Boolean? (readonly)

Note:

Default: false

Skip enum checks.

This means you may read enum values you don't know about yet. Make sure to always check the values of enums you encounter in the manifest.

Returns:

  • (Boolean, nil) 


29
30
31
 
# File 'cloud_assembly_schema/load_manifest_options.rb', line 29

def skip_enum_check
  @skip_enum_check
end

#skip_version_check ⇒ Boolean? (readonly)

Note:

Default: false

Skip the version check.

This means you may read a newer cloud assembly than the CX API is designed to support, and your application may not be aware of all features that in use in the Cloud Assembly.

Returns:

  • (Boolean, nil) 


38
39
40
 
# File 'cloud_assembly_schema/load_manifest_options.rb', line 38

def skip_version_check
  @skip_version_check
end

#topo_sort ⇒ Boolean? (readonly)

Note:

Default: true

Topologically sort all artifacts.

This parameter is only respected by the constructor of CloudAssembly. The property lives here for backwards compatibility reasons.

Returns:

  • (Boolean, nil) 


46
47
48
 
# File 'cloud_assembly_schema/load_manifest_options.rb', line 46

def topo_sort
  @topo_sort
end

#validate_schema ⇒ Boolean? (readonly)

Note:

Default: false, unless $TESTING_CDK is set to '1'

Validate the file according to the declared JSON Schema.

Be aware that JSON Schema validation has a significant performance cost (about 10x over not validating).

Returns:

  • (Boolean, nil) 


54
55
56
 
# File 'cloud_assembly_schema/load_manifest_options.rb', line 54

def validate_schema
  @validate_schema
end

Class Method Details

.jsii_properties ⇒ Object 



56
57
58
59
60
61
62
63
 
# File 'cloud_assembly_schema/load_manifest_options.rb', line 56

def self.jsii_properties
  {
    :skip_enum_check => "skipEnumCheck",
    :skip_version_check => "skipVersionCheck",
    :topo_sort => "topoSort",
    :validate_schema => "validateSchema",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



65
66
67
68
69
70
71
72
73
74
 
# File 'cloud_assembly_schema/load_manifest_options.rb', line 65

def to_jsii
  result = {}
  result.merge!({
    "skipEnumCheck" => @skip_enum_check,
    "skipVersionCheck" => @skip_version_check,
    "topoSort" => @topo_sort,
    "validateSchema" => @validate_schema,
  })
  result.compact
end