Class: AWSCDK::CloudFormation::CfnModuleVersionProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cloud_formation/cfn_module_version_props.rb

Overview

Properties for defining a CfnModuleVersion.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(module_name:, module_package:) ⇒ CfnModuleVersionProps

Returns a new instance of CfnModuleVersionProps.

Parameters:

  • module_name (String) —

    The name of the module being registered.

  • module_package (String) —

    A URL to the S3 bucket for the package that contains the template fragment and schema files for the module version to register.



11
12
13
14
15
16
 
# File 'cloud_formation/cfn_module_version_props.rb', line 11

def initialize(module_name:, module_package:)
  @module_name = module_name
  Jsii::Type.check_type(@module_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "moduleName")
  @module_package = module_package
  Jsii::Type.check_type(@module_package, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modulePackage")
end

Instance Attribute Details

#module_name ⇒ String (readonly)

The name of the module being registered.

Returns:

  • (String)

See Also:



22
23
24
 
# File 'cloud_formation/cfn_module_version_props.rb', line 22

def module_name
  @module_name
end

#module_package ⇒ String (readonly)

A URL to the S3 bucket for the package that contains the template fragment and schema files for the module version to register.

For more information, see Module structure and requirements in the CloudFormation Command Line Interface (CLI) User Guide .

To register the module version, you must have s3:GetObject permissions to access the S3 objects.

Returns:

  • (String)

See Also:



31
32
33
 
# File 'cloud_formation/cfn_module_version_props.rb', line 31

def module_package
  @module_package
end

Class Method Details

.jsii_properties ⇒ Object 



33
34
35
36
37
38
 
# File 'cloud_formation/cfn_module_version_props.rb', line 33

def self.jsii_properties
  {
    :module_name => "moduleName",
    :module_package => "modulePackage",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



40
41
42
43
44
45
46
47
 
# File 'cloud_formation/cfn_module_version_props.rb', line 40

def to_jsii
  result = {}
  result.merge!({
    "moduleName" => @module_name,
    "modulePackage" => @module_package,
  })
  result.compact
end