Class: AWSCDK::AppConfig::Application

Inherits:
Resource
  • Object
show all
Includes:
IApplication, IExtensible
Defined in:
app_config/application.rb

Overview

An AWS AppConfig application.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ Application

Returns a new instance of Application.

Parameters:



15
16
17
18
19
20
21
# File 'app_config/application.rb', line 15

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::AppConfig::ApplicationProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkFwcGxpY2F0aW9uUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.add_agent_to_ecs(task_def) ⇒ void

This method returns an undefined value.

Adds the AWS AppConfig Agent as a container to the provided ECS task definition.

Parameters:



64
65
66
67
# File 'app_config/application.rb', line 64

def self.add_agent_to_ecs(task_def)
  Jsii::Type.check_type(task_def, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLlRhc2tEZWZpbml0aW9uIn0=")), "taskDef")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.Application", "addAgentToEcs", [task_def])
end

.from_application_arn(scope, id, application_arn) ⇒ AWSCDK::AppConfig::IApplication

Imports an AWS AppConfig application into the CDK using its Amazon Resource Name (ARN).

Parameters:

  • scope (Constructs::Construct)

    The parent construct.

  • id (String)

    The name of the application construct.

  • application_arn (String)

    The Amazon Resource Name (ARN) of the application.

Returns:



75
76
77
78
79
80
# File 'app_config/application.rb', line 75

def self.from_application_arn(scope, id, application_arn)
  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(application_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.Application", "fromApplicationArn", [scope, id, application_arn])
end

.from_application_id(scope, id, application_id) ⇒ AWSCDK::AppConfig::IApplication

Imports an AWS AppConfig application into the CDK using its ID.

Parameters:

  • scope (Constructs::Construct)

    The parent construct.

  • id (String)

    The name of the application construct.

  • application_id (String)

    The ID of the application.

Returns:



88
89
90
91
92
93
# File 'app_config/application.rb', line 88

def self.from_application_id(scope, id, application_id)
  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(application_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.Application", "fromApplicationId", [scope, id, application_id])
end

.get_lambda_layer_version_arn(region, platform = nil) ⇒ String

Retrieves the Lambda layer version Amazon Resource Name (ARN) for the AWS AppConfig Lambda extension.

Parameters:

  • region (String)

    The region for the Lambda layer (for example, 'us-east-1').

  • platform (AWSCDK::AppConfig::Platform, nil) (defaults to: nil)

    The platform for the Lambda layer (default is Platform.X86_64).

Returns:

  • (String)

    Lambda layer version ARN



100
101
102
103
104
# File 'app_config/application.rb', line 100

def self.get_lambda_layer_version_arn(region, platform = nil)
  Jsii::Type.check_type(region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "region")
  Jsii::Type.check_type(platform, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLlBsYXRmb3JtIn0=")), "platform") unless platform.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.Application", "getLambdaLayerVersionArn", [region, platform])
end

.jsii_overridable_methodsObject



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/application.rb', line 23

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :application_arn => { kind: :property, name: "applicationArn", is_optional: false },
    :application_id => { kind: :property, name: "applicationId", is_optional: false },
    :application_ref => { kind: :property, name: "applicationRef", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :extensible => { kind: :property, name: "extensible", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_environment => { kind: :method, name: "addEnvironment", is_optional: false },
    :add_existing_environment => { kind: :method, name: "addExistingEnvironment", is_optional: false },
    :add_extension => { kind: :method, name: "addExtension", is_optional: false },
    :add_hosted_configuration => { kind: :method, name: "addHostedConfiguration", is_optional: false },
    :add_sourced_configuration => { kind: :method, name: "addSourcedConfiguration", is_optional: false },
    :at_deployment_tick => { kind: :method, name: "atDeploymentTick", is_optional: false },
    :environments => { kind: :method, name: "environments", 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

.PROPERTY_INJECTION_IDString

Uniquely identifies this class.

Returns:

  • (String)


152
153
154
# File 'app_config/application.rb', line 152

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_appconfig.Application", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_environment(id, options = nil) ⇒ AWSCDK::AppConfig::IEnvironment

Adds an environment.

Parameters:

Returns:



296
297
298
299
300
301
# File 'app_config/application.rb', line 296

def add_environment(id, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::AppConfig::EnvironmentOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkVudmlyb25tZW50T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("addEnvironment", [id, options])
end

#add_existing_environment(environment) ⇒ void

This method returns an undefined value.

Adds an existing environment.



307
308
309
310
# File 'app_config/application.rb', line 307

def add_existing_environment(environment)
  Jsii::Type.check_type(environment, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcHBjb25maWcuSUVudmlyb25tZW50UmVmIn0=")), "environment")
  jsii_call_method("addExistingEnvironment", [environment])
end

#add_extension(extension) ⇒ void

This method returns an undefined value.

Adds an extension association to the application.

Parameters:



316
317
318
319
# File 'app_config/application.rb', line 316

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

#add_hosted_configuration(id, options) ⇒ AWSCDK::AppConfig::HostedConfiguration

Adds a hosted configuration.



326
327
328
329
330
331
# File 'app_config/application.rb', line 326

def add_hosted_configuration(id, options)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::AppConfig::HostedConfigurationOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkhvc3RlZENvbmZpZ3VyYXRpb25PcHRpb25zIn0=")), "options")
  jsii_call_method("addHostedConfiguration", [id, options])
end

#add_sourced_configuration(id, options) ⇒ AWSCDK::AppConfig::SourcedConfiguration

Adds a sourced configuration.



338
339
340
341
342
343
# File 'app_config/application.rb', line 338

def add_sourced_configuration(id, options)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::AppConfig::SourcedConfigurationOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLlNvdXJjZWRDb25maWd1cmF0aW9uT3B0aW9ucyJ9")), "options")
  jsii_call_method("addSourcedConfiguration", [id, options])
end

#application_arnString

The Amazon Resource Name (ARN) of the application.

Returns:

  • (String)


159
160
161
# File 'app_config/application.rb', line 159

def application_arn()
  jsii_get_property("applicationArn")
end

#application_idString

The ID of the application.

Returns:

  • (String)


166
167
168
# File 'app_config/application.rb', line 166

def application_id()
  jsii_get_property("applicationId")
end

#application_refAWSCDK::Interfaces::AWSAppconfig::ApplicationReference

A reference to a Application resource.



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

def application_ref()
  jsii_get_property("applicationRef")
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



234
235
236
237
# File 'app_config/application.rb', line 234

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



251
252
253
254
# File 'app_config/application.rb', line 251

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
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:



350
351
352
353
354
355
# File 'app_config/application.rb', line 350

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

#descriptionString?

The description of the application.

Returns:

  • (String, nil)


180
181
182
# File 'app_config/application.rb', line 180

def description()
  jsii_get_property("description")
end

#envAWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.



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

def env()
  jsii_get_property("env")
end

#environmentsArray<AWSCDK::AppConfig::IEnvironment>

Returns the list of associated environments.



360
361
362
# File 'app_config/application.rb', line 360

def environments()
  jsii_call_method("environments", [])
end

#extensibleAWSCDK::AppConfig::ExtensibleBase



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

def extensible()
  jsii_get_property("extensible")
end

#extensible=(value) ⇒ Object



196
197
198
199
# File 'app_config/application.rb', line 196

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

#generate_physical_nameString

Returns:

  • (String)


257
258
259
# File 'app_config/application.rb', line 257

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String)

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents)

    The format of the ARN of this resource.

Returns:

  • (String)


271
272
273
274
275
276
# File 'app_config/application.rb', line 271

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String)

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String)


286
287
288
289
# File 'app_config/application.rb', line 286

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#nameString?

The name of the application.

Returns:

  • (String, nil)


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

def name()
  jsii_get_property("name")
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


109
110
111
# File 'app_config/application.rb', line 109

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 an application.

Parameters:



370
371
372
373
374
375
376
# File 'app_config/application.rb', line 370

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 an application.

Parameters:



383
384
385
386
387
388
# File 'app_config/application.rb', line 383

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 an application.

Parameters:



395
396
397
398
399
400
# File 'app_config/application.rb', line 395

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 an application.

Parameters:



407
408
409
410
411
412
# File 'app_config/application.rb', line 407

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 an application.

Parameters:



419
420
421
422
423
424
# File 'app_config/application.rb', line 419

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 an application.

Parameters:



431
432
433
434
435
436
# File 'app_config/application.rb', line 431

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

#physical_nameString

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String)


138
139
140
# File 'app_config/application.rb', line 138

def physical_name()
  jsii_get_property("physicalName")
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 an application.

Parameters:



443
444
445
446
447
448
# File 'app_config/application.rb', line 443

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 an application.

Parameters:



455
456
457
458
459
460
# File 'app_config/application.rb', line 455

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

#stackAWSCDK::Stack

The stack in which this resource is defined.

Returns:



145
146
147
# File 'app_config/application.rb', line 145

def stack()
  jsii_get_property("stack")
end

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)


204
205
206
# File 'app_config/application.rb', line 204

def to_string()
  jsii_call_method("toString", [])
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>)

Returns:

  • (Constructs::IConstruct)


217
218
219
220
221
222
# File 'app_config/application.rb', line 217

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