Class: AWSCDK::AppConfig::SourcedConfiguration

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

Overview

A sourced configuration represents configuration stored in an Amazon S3 bucket, AWS Secrets Manager secret, Systems Manager (SSM) Parameter Store parameter, SSM document, or AWS CodePipeline.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ SourcedConfiguration

Returns a new instance of SourcedConfiguration.

Parameters:



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

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::AppConfig::SourcedConfigurationProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLlNvdXJjZWRDb25maWd1cmF0aW9uUHJvcHMifQ==")), "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
 
# File 'app_config/sourced_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 },
    :location => { kind: :property, name: "location", is_optional: false },
    :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 },
    :name => { kind: :property, name: "name", is_optional: true },
    :retrieval_role => { kind: :property, name: "retrievalRole", is_optional: true },
    :source_key => { kind: :property, name: "sourceKey", is_optional: true },
    :type => { kind: :property, name: "type", is_optional: true },
    :validators => { kind: :property, name: "validators", 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.



221
222
223
 
# File 'app_config/sourced_configuration.rb', line 221

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:



229
230
231
232
 
# File 'app_config/sourced_configuration.rb', line 229

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:



68
69
70
 
# File 'app_config/sourced_configuration.rb', line 68

def application()
  jsii_get_property("application")
end

#application_id ⇒ String

Returns:

  • (String) 


168
169
170
 
# File 'app_config/sourced_configuration.rb', line 168

def application_id()
  jsii_get_property("applicationId")
end

#application_id=(value) ⇒ Object 



172
173
174
175
 
# File 'app_config/sourced_configuration.rb', line 172

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:



239
240
241
242
243
244
 
# File 'app_config/sourced_configuration.rb', line 239

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) 


75
76
77
 
# File 'app_config/sourced_configuration.rb', line 75

def configuration_profile_arn()
  jsii_get_property("configurationProfileArn")
end

#configuration_profile_id ⇒ String

The ID of the configuration profile.

Returns:

  • (String) 


82
83
84
 
# File 'app_config/sourced_configuration.rb', line 82

def configuration_profile_id()
  jsii_get_property("configurationProfileId")
end

#deletion_protection_check ⇒ AWSCDK::AppConfig::DeletionProtectionCheck?

Returns:



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

def deletion_protection_check()
  jsii_get_property("deletionProtectionCheck")
end

#deletion_protection_check=(value) ⇒ Object 



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

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.



247
248
249
 
# File 'app_config/sourced_configuration.rb', line 247

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

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

The environments to deploy to.

Returns:



110
111
112
 
# File 'app_config/sourced_configuration.rb', line 110

def deploy_to()
  jsii_get_property("deployTo")
end

#deployment_key ⇒ AWSCDK::KMS::IKey?

The deployment key for the configuration.

Returns:



96
97
98
 
# File 'app_config/sourced_configuration.rb', line 96

def deployment_key()
  jsii_get_property("deploymentKey")
end

#deployment_strategy ⇒ AWSCDK::AppConfig::IDeploymentStrategy?

The deployment strategy for the configuration.

Returns:



103
104
105
 
# File 'app_config/sourced_configuration.rb', line 103

def deployment_strategy()
  jsii_get_property("deploymentStrategy")
end

#description ⇒ String?

The description of the configuration.

Returns:

  • (String, nil) 


117
118
119
 
# File 'app_config/sourced_configuration.rb', line 117

def description()
  jsii_get_property("description")
end

#extensible ⇒ AWSCDK::AppConfig::ExtensibleBase

Returns:



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

def extensible()
  jsii_get_property("extensible")
end

#extensible=(value) ⇒ Object 



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

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

#location ⇒ AWSCDK::AppConfig::ConfigurationSource

The location where the configuration is stored.

Returns:



89
90
91
 
# File 'app_config/sourced_configuration.rb', line 89

def location()
  jsii_get_property("location")
end

#name ⇒ String?

The name of the configuration.

Returns:

  • (String, nil) 


124
125
126
 
# File 'app_config/sourced_configuration.rb', line 124

def name()
  jsii_get_property("name")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


61
62
63
 
# File 'app_config/sourced_configuration.rb', line 61

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:



257
258
259
260
261
262
263
 
# File 'app_config/sourced_configuration.rb', line 257

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:



270
271
272
273
274
275
 
# File 'app_config/sourced_configuration.rb', line 270

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:



282
283
284
285
286
287
 
# File 'app_config/sourced_configuration.rb', line 282

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:



294
295
296
297
298
299
 
# File 'app_config/sourced_configuration.rb', line 294

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:



306
307
308
309
310
311
 
# File 'app_config/sourced_configuration.rb', line 306

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:



318
319
320
321
322
323
 
# File 'app_config/sourced_configuration.rb', line 318

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:



330
331
332
333
334
335
 
# File 'app_config/sourced_configuration.rb', line 330

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:



342
343
344
345
346
347
 
# File 'app_config/sourced_configuration.rb', line 342

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

#retrieval_role ⇒ AWSCDK::IAM::IRole?

The IAM role to retrieve the configuration.

Returns:



131
132
133
 
# File 'app_config/sourced_configuration.rb', line 131

def retrieval_role()
  jsii_get_property("retrievalRole")
end

#source_key ⇒ AWSCDK::KMS::IKey?

The key to decrypt the configuration if applicable.

This key can be used when storing configuration in AWS Secrets Manager, Systems Manager Parameter Store, or Amazon S3.

Returns:



142
143
144
 
# File 'app_config/sourced_configuration.rb', line 142

def source_key()
  jsii_get_property("sourceKey")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


200
201
202
 
# File 'app_config/sourced_configuration.rb', line 200

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

#type ⇒ AWSCDK::AppConfig::ConfigurationType?

The configuration type.

Returns:



149
150
151
 
# File 'app_config/sourced_configuration.rb', line 149

def type()
  jsii_get_property("type")
end

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

The validators for the configuration.

Returns:



156
157
158
 
# File 'app_config/sourced_configuration.rb', line 156

def validators()
  jsii_get_property("validators")
end

#version_number ⇒ String?

The version number of the configuration to deploy.

Returns:

  • (String, nil) 


163
164
165
 
# File 'app_config/sourced_configuration.rb', line 163

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



213
214
215
216
217
218
 
# File 'app_config/sourced_configuration.rb', line 213

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