Class: AWSCDK::ServiceCatalog::ProductStackHistoryProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
service_catalog/product_stack_history_props.rb

Overview

Properties for a ProductStackHistory.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(current_version_locked:, current_version_name:, product_stack:, description: nil, directory: nil, validate_template: nil) ⇒ ProductStackHistoryProps

Returns a new instance of ProductStackHistoryProps.

Parameters:

  • current_version_locked (Boolean) —

    If this is set to true, the ProductStack will not be overwritten if a snapshot is found for the currentVersionName.

  • current_version_name (String) —

    The current version name of the ProductStack.

  • product_stack (AWSCDK::ServiceCatalog::ProductStack) —

    The ProductStack whose history will be retained as a snapshot.

  • description (String, nil) (defaults to: nil) —

    The description of the product version.

  • directory (String, nil) (defaults to: nil) —

    The directory where template snapshots will be stored.

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

    Whether the specified product template will be validated by CloudFormation.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'service_catalog/product_stack_history_props.rb', line 13

def initialize(current_version_locked:, current_version_name:, product_stack:, description: nil, directory: nil, validate_template: nil)
  @current_version_locked = current_version_locked
  Jsii::Type.check_type(@current_version_locked, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "currentVersionLocked")
  @current_version_name = current_version_name
  Jsii::Type.check_type(@current_version_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "currentVersionName")
  @product_stack = product_stack
  Jsii::Type.check_type(@product_stack, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWNhdGFsb2cuUHJvZHVjdFN0YWNrIn0=")), "productStack")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @directory = directory
  Jsii::Type.check_type(@directory, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "directory") unless @directory.nil?
  @validate_template = validate_template
  Jsii::Type.check_type(@validate_template, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "validateTemplate") unless @validate_template.nil?
end

Instance Attribute Details

#current_version_locked ⇒ Boolean (readonly)

If this is set to true, the ProductStack will not be overwritten if a snapshot is found for the currentVersionName.

Returns:

  • (Boolean) 


31
32
33
 
# File 'service_catalog/product_stack_history_props.rb', line 31

def current_version_locked
  @current_version_locked
end

#current_version_name ⇒ String (readonly)

The current version name of the ProductStack.

Returns:

  • (String) 


35
36
37
 
# File 'service_catalog/product_stack_history_props.rb', line 35

def current_version_name
  @current_version_name
end

#description ⇒ String? (readonly)

Note:

Default: - No description provided

The description of the product version.

Returns:

  • (String, nil) 


44
45
46
 
# File 'service_catalog/product_stack_history_props.rb', line 44

def description
  @description
end

#directory ⇒ String? (readonly)

Note:

Default: 'product-stack-snapshots'

The directory where template snapshots will be stored.

Returns:

  • (String, nil) 


49
50
51
 
# File 'service_catalog/product_stack_history_props.rb', line 49

def directory
  @directory
end

#product_stack ⇒ AWSCDK::ServiceCatalog::ProductStack (readonly)

The ProductStack whose history will be retained as a snapshot.

Returns:



39
40
41
 
# File 'service_catalog/product_stack_history_props.rb', line 39

def product_stack
  @product_stack
end

#validate_template ⇒ Boolean? (readonly)

Note:

Default: true

Whether the specified product template will be validated by CloudFormation.

If turned off, an invalid template configuration can be stored.

Returns:

  • (Boolean, nil) 


56
57
58
 
# File 'service_catalog/product_stack_history_props.rb', line 56

def validate_template
  @validate_template
end

Class Method Details

.jsii_properties ⇒ Object 



58
59
60
61
62
63
64
65
66
67
 
# File 'service_catalog/product_stack_history_props.rb', line 58

def self.jsii_properties
  {
    :current_version_locked => "currentVersionLocked",
    :current_version_name => "currentVersionName",
    :product_stack => "productStack",
    :description => "description",
    :directory => "directory",
    :validate_template => "validateTemplate",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'service_catalog/product_stack_history_props.rb', line 69

def to_jsii
  result = {}
  result.merge!({
    "currentVersionLocked" => @current_version_locked,
    "currentVersionName" => @current_version_name,
    "productStack" => @product_stack,
    "description" => @description,
    "directory" => @directory,
    "validateTemplate" => @validate_template,
  })
  result.compact
end