Class: AWSCDK::AppConfig::ExtensibleBase

Inherits:
Jsii::Object
  • Object
show all
Includes:
IExtensible
Defined in:
app_config/extensible_base.rb

Overview

This class is meant to be used by AWS AppConfig resources (application, configuration profile, environment) directly.

There is currently no use for this class outside of the AWS AppConfig construct implementation. It is intended to be used with the resources since there is currently no way to inherit from two classes (at least within JSII constraints).

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, resource_arn, resource_name = nil) ⇒ ExtensibleBase

Returns a new instance of ExtensibleBase.

Parameters:

  • scope (Constructs::Construct)
  • resource_arn (String)
  • resource_name (String, nil) (defaults to: nil) 


17
18
19
20
21
22
 
# File 'app_config/extensible_base.rb', line 17

def initialize(scope, resource_arn, resource_name = nil)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(resource_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceArn")
  Jsii::Type.check_type(resource_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceName") unless resource_name.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, resource_arn, resource_name)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'app_config/extensible_base.rb', line 24

def self.jsii_overridable_methods
  {
    :add_extension => { kind: :method, name: "addExtension", is_optional: false },
    :at_deployment_tick => { kind: :method, name: "atDeploymentTick", is_optional: false },
    :on => { kind: :method, name: "on", is_optional: false },
    :on_deployment_baking => { kind: :method, name: "onDeploymentBaking", is_optional: false },
    :on_deployment_complete => { kind: :method, name: "onDeploymentComplete", is_optional: false },
    :on_deployment_rolled_back => { kind: :method, name: "onDeploymentRolledBack", is_optional: false },
    :on_deployment_start => { kind: :method, name: "onDeploymentStart", is_optional: false },
    :on_deployment_step => { kind: :method, name: "onDeploymentStep", is_optional: false },
    :pre_create_hosted_configuration_version => { kind: :method, name: "preCreateHostedConfigurationVersion", is_optional: false },
    :pre_start_deployment => { kind: :method, name: "preStartDeployment", is_optional: false },
  }
end

Instance Method Details

#add_extension(extension) ⇒ void

This method returns an undefined value.

Adds an extension association to the derived resource.

Parameters:



43
44
45
46
 
# File 'app_config/extensible_base.rb', line 43

def add_extension(extension)
  Jsii::Type.check_type(extension, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLklFeHRlbnNpb24ifQ==")), "extension")
  jsii_call_method("addExtension", [extension])
end

#at_deployment_tick(event_destination, options = nil) ⇒ void

This method returns an undefined value.

Adds an AT_DEPLOYMENT_TICK extension with the provided event destination and also creates an extension association to the derived resource.

Parameters:



53
54
55
56
57
58
 
# File 'app_config/extensible_base.rb', line 53

def at_deployment_tick(event_destination, options = nil)
  Jsii::Type.check_type(event_destination, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLklFdmVudERlc3RpbmF0aW9uIn0=")), "eventDestination")
  options = options.is_a?(Hash) ? ::AWSCDK::AppConfig::ExtensionOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkV4dGVuc2lvbk9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("atDeploymentTick", [event_destination, options])
end

#on(action_point, event_destination, options = nil) ⇒ void

This method returns an undefined value.

Adds an extension defined by the action point and event destination and also creates an extension association to the derived resource.

Parameters:



66
67
68
69
70
71
72
 
# File 'app_config/extensible_base.rb', line 66

def on(action_point, event_destination, options = nil)
  Jsii::Type.check_type(action_point, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkFjdGlvblBvaW50In0=")), "actionPoint")
  Jsii::Type.check_type(event_destination, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLklFdmVudERlc3RpbmF0aW9uIn0=")), "eventDestination")
  options = options.is_a?(Hash) ? ::AWSCDK::AppConfig::ExtensionOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkV4dGVuc2lvbk9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("on", [action_point, event_destination, options])
end

#on_deployment_baking(event_destination, options = nil) ⇒ void

This method returns an undefined value.

Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the derived resource.

Parameters:



79
80
81
82
83
84
 
# File 'app_config/extensible_base.rb', line 79

def on_deployment_baking(event_destination, options = nil)
  Jsii::Type.check_type(event_destination, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLklFdmVudERlc3RpbmF0aW9uIn0=")), "eventDestination")
  options = options.is_a?(Hash) ? ::AWSCDK::AppConfig::ExtensionOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkV4dGVuc2lvbk9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("onDeploymentBaking", [event_destination, options])
end

#on_deployment_complete(event_destination, options = nil) ⇒ void

This method returns an undefined value.

Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the derived resource.

Parameters:



91
92
93
94
95
96
 
# File 'app_config/extensible_base.rb', line 91

def on_deployment_complete(event_destination, options = nil)
  Jsii::Type.check_type(event_destination, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLklFdmVudERlc3RpbmF0aW9uIn0=")), "eventDestination")
  options = options.is_a?(Hash) ? ::AWSCDK::AppConfig::ExtensionOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkV4dGVuc2lvbk9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("onDeploymentComplete", [event_destination, options])
end

#on_deployment_rolled_back(event_destination, options = nil) ⇒ void

This method returns an undefined value.

Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the derived resource.

Parameters:



103
104
105
106
107
108
 
# File 'app_config/extensible_base.rb', line 103

def on_deployment_rolled_back(event_destination, options = nil)
  Jsii::Type.check_type(event_destination, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLklFdmVudERlc3RpbmF0aW9uIn0=")), "eventDestination")
  options = options.is_a?(Hash) ? ::AWSCDK::AppConfig::ExtensionOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkV4dGVuc2lvbk9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("onDeploymentRolledBack", [event_destination, options])
end

#on_deployment_start(event_destination, options = nil) ⇒ void

This method returns an undefined value.

Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the derived resource.

Parameters:



115
116
117
118
119
120
 
# File 'app_config/extensible_base.rb', line 115

def on_deployment_start(event_destination, options = nil)
  Jsii::Type.check_type(event_destination, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLklFdmVudERlc3RpbmF0aW9uIn0=")), "eventDestination")
  options = options.is_a?(Hash) ? ::AWSCDK::AppConfig::ExtensionOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkV4dGVuc2lvbk9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("onDeploymentStart", [event_destination, options])
end

#on_deployment_step(event_destination, options = nil) ⇒ void

This method returns an undefined value.

Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the derived resource.

Parameters:



127
128
129
130
131
132
 
# File 'app_config/extensible_base.rb', line 127

def on_deployment_step(event_destination, options = nil)
  Jsii::Type.check_type(event_destination, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLklFdmVudERlc3RpbmF0aW9uIn0=")), "eventDestination")
  options = options.is_a?(Hash) ? ::AWSCDK::AppConfig::ExtensionOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkV4dGVuc2lvbk9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("onDeploymentStep", [event_destination, options])
end

#pre_create_hosted_configuration_version(event_destination, options = nil) ⇒ void

This method returns an undefined value.

Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the derived resource.

Parameters:



139
140
141
142
143
144
 
# File 'app_config/extensible_base.rb', line 139

def pre_create_hosted_configuration_version(event_destination, options = nil)
  Jsii::Type.check_type(event_destination, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLklFdmVudERlc3RpbmF0aW9uIn0=")), "eventDestination")
  options = options.is_a?(Hash) ? ::AWSCDK::AppConfig::ExtensionOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkV4dGVuc2lvbk9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("preCreateHostedConfigurationVersion", [event_destination, options])
end

#pre_start_deployment(event_destination, options = nil) ⇒ void

This method returns an undefined value.

Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the derived resource.

Parameters:



151
152
153
154
155
156
 
# File 'app_config/extensible_base.rb', line 151

def pre_start_deployment(event_destination, options = nil)
  Jsii::Type.check_type(event_destination, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLklFdmVudERlc3RpbmF0aW9uIn0=")), "eventDestination")
  options = options.is_a?(Hash) ? ::AWSCDK::AppConfig::ExtensionOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkV4dGVuc2lvbk9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("preStartDeployment", [event_destination, options])
end