Class: AWSCDK::AppConfig::HostedConfiguration

Inherits:
Constructs::Construct
  • Object
show all
Includes:
IConfiguration, IExtensible
Defined in:
app_config/hosted_configuration.rb

Overview

A hosted configuration represents configuration stored in the AWS AppConfig hosted configuration store.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ HostedConfiguration

Returns a new instance of HostedConfiguration.

Parameters:



13
14
15
16
17
18
19
 
# File 'app_config/hosted_configuration.rb', line 13

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::AppConfig::HostedConfigurationProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkhvc3RlZENvbmZpZ3VyYXRpb25Qcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'app_config/hosted_configuration.rb', line 21

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :application => { kind: :property, name: "application", is_optional: false },
    :configuration_profile_arn => { kind: :property, name: "configurationProfileArn", is_optional: false },
    :configuration_profile_id => { kind: :property, name: "configurationProfileId", is_optional: false },
    :content => { kind: :property, name: "content", is_optional: false },
    :hosted_configuration_version_arn => { kind: :property, name: "hostedConfigurationVersionArn", is_optional: false },
    :content_type => { kind: :property, name: "contentType", is_optional: true },
    :deployment_key => { kind: :property, name: "deploymentKey", is_optional: true },
    :deployment_strategy => { kind: :property, name: "deploymentStrategy", is_optional: true },
    :deploy_to => { kind: :property, name: "deployTo", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :latest_version_number => { kind: :property, name: "latestVersionNumber", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :type => { kind: :property, name: "type", is_optional: true },
    :validators => { kind: :property, name: "validators", is_optional: true },
    :version_label => { kind: :property, name: "versionLabel", is_optional: true },
    :version_number => { kind: :property, name: "versionNumber", is_optional: true },
    :application_id => { kind: :property, name: "applicationId", is_optional: false },
    :extensible => { kind: :property, name: "extensible", is_optional: false },
    :deletion_protection_check => { kind: :property, name: "deletionProtectionCheck", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :add_existing_environments_to_application => { kind: :method, name: "addExistingEnvironmentsToApplication", is_optional: false },
    :add_extension => { kind: :method, name: "addExtension", is_optional: false },
    :at_deployment_tick => { kind: :method, name: "atDeploymentTick", is_optional: false },
    :deploy_config_to_environments => { kind: :method, name: "deployConfigToEnvironments", 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_existing_environments_to_application ⇒ void

This method returns an undefined value.



236
237
238
 
# File 'app_config/hosted_configuration.rb', line 236

def add_existing_environments_to_application()
  jsii_call_method("addExistingEnvironmentsToApplication", [])
end

#add_extension(extension) ⇒ void

This method returns an undefined value.

Adds an extension association to the configuration profile.

Parameters:



244
245
246
247
 
# File 'app_config/hosted_configuration.rb', line 244

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

#application ⇒ AWSCDK::AppConfig::IApplication

The application associated with the configuration.

Returns:



70
71
72
 
# File 'app_config/hosted_configuration.rb', line 70

def application()
  jsii_get_property("application")
end

#application_id ⇒ String

Returns:

  • (String) 


183
184
185
 
# File 'app_config/hosted_configuration.rb', line 183

def application_id()
  jsii_get_property("applicationId")
end

#application_id=(value) ⇒ Object 



187
188
189
190
 
# File 'app_config/hosted_configuration.rb', line 187

def application_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  jsii_set_property("applicationId", value)
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 an application.

Parameters:



254
255
256
257
258
259
 
# File 'app_config/hosted_configuration.rb', line 254

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

#configuration_profile_arn ⇒ String

The Amazon Resource Name (ARN) of the configuration profile.

Returns:

  • (String) 


77
78
79
 
# File 'app_config/hosted_configuration.rb', line 77

def configuration_profile_arn()
  jsii_get_property("configurationProfileArn")
end

#configuration_profile_id ⇒ String

The ID of the configuration profile.

Returns:

  • (String) 


84
85
86
 
# File 'app_config/hosted_configuration.rb', line 84

def configuration_profile_id()
  jsii_get_property("configurationProfileId")
end

#content ⇒ String

The content of the hosted configuration.

Returns:

  • (String) 


91
92
93
 
# File 'app_config/hosted_configuration.rb', line 91

def content()
  jsii_get_property("content")
end

#content_type ⇒ String?

The configuration content type, specified as a standard MIME type. Supported examples include: - text/plain - application/json - application/octet-stream - application/x-yaml.

For an up-to-date list of valid MIME types, see: https://www.iana.org/assignments/media-types/media-types.xhtml

Returns:

  • (String, nil) 


108
109
110
 
# File 'app_config/hosted_configuration.rb', line 108

def content_type()
  jsii_get_property("contentType")
end

#deletion_protection_check ⇒ AWSCDK::AppConfig::DeletionProtectionCheck?

Returns:



203
204
205
 
# File 'app_config/hosted_configuration.rb', line 203

def deletion_protection_check()
  jsii_get_property("deletionProtectionCheck")
end

#deletion_protection_check=(value) ⇒ Object 



207
208
209
210
 
# File 'app_config/hosted_configuration.rb', line 207

def deletion_protection_check=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkRlbGV0aW9uUHJvdGVjdGlvbkNoZWNrIn0=")), "deletionProtectionCheck") unless value.nil?
  jsii_set_property("deletionProtectionCheck", value)
end

#deploy_config_to_environments ⇒ void

This method returns an undefined value.



262
263
264
 
# File 'app_config/hosted_configuration.rb', line 262

def deploy_config_to_environments()
  jsii_call_method("deployConfigToEnvironments", [])
end

#deploy_to ⇒ Array<AWSCDK::AppConfig::IEnvironment>?

The environments to deploy to.

Returns:



129
130
131
 
# File 'app_config/hosted_configuration.rb', line 129

def deploy_to()
  jsii_get_property("deployTo")
end

#deployment_key ⇒ AWSCDK::KMS::IKey?

The deployment key for the configuration.

Returns:



115
116
117
 
# File 'app_config/hosted_configuration.rb', line 115

def deployment_key()
  jsii_get_property("deploymentKey")
end

#deployment_strategy ⇒ AWSCDK::AppConfig::IDeploymentStrategy?

The deployment strategy for the configuration.

Returns:



122
123
124
 
# File 'app_config/hosted_configuration.rb', line 122

def deployment_strategy()
  jsii_get_property("deploymentStrategy")
end

#description ⇒ String?

The description of the configuration.

Returns:

  • (String, nil) 


136
137
138
 
# File 'app_config/hosted_configuration.rb', line 136

def description()
  jsii_get_property("description")
end

#extensible ⇒ AWSCDK::AppConfig::ExtensibleBase

Returns:



193
194
195
 
# File 'app_config/hosted_configuration.rb', line 193

def extensible()
  jsii_get_property("extensible")
end

#extensible=(value) ⇒ Object 



197
198
199
200
 
# File 'app_config/hosted_configuration.rb', line 197

def extensible=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkV4dGVuc2libGVCYXNlIn0=")), "extensible")
  jsii_set_property("extensible", value)
end

#hosted_configuration_version_arn ⇒ String

The Amazon Resource Name (ARN) of the hosted configuration version.

Returns:

  • (String) 


98
99
100
 
# File 'app_config/hosted_configuration.rb', line 98

def hosted_configuration_version_arn()
  jsii_get_property("hostedConfigurationVersionArn")
end

#latest_version_number ⇒ Numeric?

The latest version number of the hosted configuration.

Returns:

  • (Numeric, nil) 


143
144
145
 
# File 'app_config/hosted_configuration.rb', line 143

def latest_version_number()
  jsii_get_property("latestVersionNumber")
end

#name ⇒ String?

The name of the configuration.

Returns:

  • (String, nil) 


150
151
152
 
# File 'app_config/hosted_configuration.rb', line 150

def name()
  jsii_get_property("name")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


63
64
65
 
# File 'app_config/hosted_configuration.rb', line 63

def node()
  jsii_get_property("node")
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 configuration profile.

Parameters:



272
273
274
275
276
277
278
 
# File 'app_config/hosted_configuration.rb', line 272

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 configuration profile.

Parameters:



285
286
287
288
289
290
 
# File 'app_config/hosted_configuration.rb', line 285

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 configuration profile.

Parameters:



297
298
299
300
301
302
 
# File 'app_config/hosted_configuration.rb', line 297

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 configuration profile.

Parameters:



309
310
311
312
313
314
 
# File 'app_config/hosted_configuration.rb', line 309

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 configuration profile.

Parameters:



321
322
323
324
325
326
 
# File 'app_config/hosted_configuration.rb', line 321

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 configuration profile.

Parameters:



333
334
335
336
337
338
 
# File 'app_config/hosted_configuration.rb', line 333

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 configuration profile.

Parameters:



345
346
347
348
349
350
 
# File 'app_config/hosted_configuration.rb', line 345

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 configuration profile.

Parameters:



357
358
359
360
361
362
 
# File 'app_config/hosted_configuration.rb', line 357

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


215
216
217
 
# File 'app_config/hosted_configuration.rb', line 215

def to_string()
  jsii_call_method("toString", [])
end

#type ⇒ AWSCDK::AppConfig::ConfigurationType?

The configuration type.

Returns:



157
158
159
 
# File 'app_config/hosted_configuration.rb', line 157

def type()
  jsii_get_property("type")
end

#validators ⇒ Array<AWSCDK::AppConfig::IValidator>?

The validators for the configuration.

Returns:



164
165
166
 
# File 'app_config/hosted_configuration.rb', line 164

def validators()
  jsii_get_property("validators")
end

#version_label ⇒ String?

The version label of the hosted configuration.

Returns:

  • (String, nil) 


171
172
173
 
# File 'app_config/hosted_configuration.rb', line 171

def version_label()
  jsii_get_property("versionLabel")
end

#version_number ⇒ String?

The version number of the hosted configuration.

Returns:

  • (String, nil) 


178
179
180
 
# File 'app_config/hosted_configuration.rb', line 178

def version_number()
  jsii_get_property("versionNumber")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



228
229
230
231
232
233
 
# File 'app_config/hosted_configuration.rb', line 228

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end