Class: AWSCDK::ElasticBeanstalk::CfnConfigurationTemplate

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSElasticbeanstalk::IConfigurationTemplateRef
Defined in:
elastic_beanstalk/cfn_configuration_template.rb

Overview

Specify an AWS Elastic Beanstalk configuration template by using the AWS::ElasticBeanstalk::ConfigurationTemplate resource in an AWS CloudFormation template.

The AWS::ElasticBeanstalk::ConfigurationTemplate resource is an AWS Elastic Beanstalk resource type that specifies an Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.

The Elastic Beanstalk console and documentation often refer to configuration templates as saved configurations . When you set configuration options in a saved configuration (configuration template), Elastic Beanstalk applies them with a particular precedence as part of applying options from multiple sources. For more information, see Configuration Options in the AWS Elastic Beanstalk Developer Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnConfigurationTemplate

Create a new AWS::ElasticBeanstalk::ConfigurationTemplate.

Parameters:



21
22
23
24
25
26
27
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 21

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::ElasticBeanstalk::CfnConfigurationTemplateProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2JlYW5zdGFsay5DZm5Db25maWd1cmF0aW9uVGVtcGxhdGVQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


180
181
182
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 180

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_elasticbeanstalk.CfnConfigurationTemplate", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_configuration_template(x) ⇒ Boolean

Checks whether the given object is a CfnConfigurationTemplate.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


82
83
84
85
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 82

def self.is_cfn_configuration_template(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_elasticbeanstalk.CfnConfigurationTemplate", "isCfnConfigurationTemplate", [x])
end

.jsii_overridable_methods ⇒ Object 



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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 29

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_template_name => { kind: :property, name: "attrTemplateName", is_optional: false },
    :configuration_template_ref => { kind: :property, name: "configurationTemplateRef", is_optional: false },
    :application_name => { kind: :property, name: "applicationName", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :environment_id => { kind: :property, name: "environmentId", is_optional: true },
    :option_settings => { kind: :property, name: "optionSettings", is_optional: true },
    :platform_arn => { kind: :property, name: "platformArn", is_optional: true },
    :solution_stack_name => { kind: :property, name: "solutionStackName", is_optional: true },
    :source_configuration => { kind: :property, name: "sourceConfiguration", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



321
322
323
324
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 321

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



333
334
335
336
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 333

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



343
344
345
346
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 343

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



354
355
356
357
358
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 354

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


411
412
413
414
415
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 411

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



421
422
423
424
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 421

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



433
434
435
436
437
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 433

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#application_name ⇒ String

The name of the Elastic Beanstalk application to associate with this configuration template.

Returns:

  • (String) 


203
204
205
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 203

def application_name()
  jsii_get_property("applicationName")
end

#application_name=(value) ⇒ Object 



207
208
209
210
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 207

def application_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationName")
  jsii_set_property("applicationName", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



446
447
448
449
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 446

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



468
469
470
471
472
473
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 468

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_template_name ⇒ String

The name of the configuration template.

Constraint: This name must be unique per application.

Returns:

  • (String) 


189
190
191
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 189

def attr_template_name()
  jsii_get_property("attrTemplateName")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



133
134
135
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 133

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


138
139
140
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 138

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


477
478
479
480
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 477

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


143
144
145
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 143

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


150
151
152
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 150

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#configuration_template_ref ⇒ AWSCDK::Interfaces::AWSElasticbeanstalk::ConfigurationTemplateReference

A reference to a ConfigurationTemplate resource.

Returns:



196
197
198
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 196

def configuration_template_ref()
  jsii_get_property("configurationTemplateRef")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


95
96
97
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 95

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

An optional description for this configuration.

Returns:

  • (String, nil) 


215
216
217
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 215

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



219
220
221
222
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 219

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



155
156
157
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 155

def env()
  jsii_get_property("env")
end

#environment_id ⇒ String?

The ID of an environment whose settings you want to use to create the configuration template.

Returns:

  • (String, nil) 


227
228
229
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 227

def environment_id()
  jsii_get_property("environmentId")
end

#environment_id=(value) ⇒ Object 



231
232
233
234
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 231

def environment_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentId") unless value.nil?
  jsii_set_property("environmentId", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



490
491
492
493
494
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 490

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



501
502
503
504
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 501

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



571
572
573
574
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 571

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


107
108
109
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 107

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


90
91
92
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 90

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



512
513
514
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 512

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



519
520
521
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 519

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#option_settings ⇒ AWSCDK::IResolvable, ...

Option values for the Elastic Beanstalk configuration, such as the instance type.

Returns:



239
240
241
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 239

def option_settings()
  jsii_get_property("optionSettings")
end

#option_settings=(value) ⇒ Object 



243
244
245
246
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 243

def option_settings=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2JlYW5zdGFsay5DZm5Db25maWd1cmF0aW9uVGVtcGxhdGUuQ29uZmlndXJhdGlvbk9wdGlvblNldHRpbmdQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "optionSettings") unless value.nil?
  jsii_set_property("optionSettings", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



312
313
314
315
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 312

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#platform_arn ⇒ String?

The Amazon Resource Name (ARN) of the custom platform.

Returns:

  • (String, nil) 


251
252
253
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 251

def platform_arn()
  jsii_get_property("platformArn")
end

#platform_arn=(value) ⇒ Object 



255
256
257
258
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 255

def platform_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "platformArn") unless value.nil?
  jsii_set_property("platformArn", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


126
127
128
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 126

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



530
531
532
533
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 530

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


537
538
539
540
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 537

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



547
548
549
550
551
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 547

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



556
557
558
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 556

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#solution_stack_name ⇒ String?

The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses.

Returns:

  • (String, nil) 


263
264
265
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 263

def solution_stack_name()
  jsii_get_property("solutionStackName")
end

#solution_stack_name=(value) ⇒ Object 



267
268
269
270
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 267

def solution_stack_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "solutionStackName") unless value.nil?
  jsii_set_property("solutionStackName", value)
end

#source_configuration ⇒ AWSCDK::IResolvable, ...

An Elastic Beanstalk configuration template to base this one on.

Returns:



275
276
277
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 275

def source_configuration()
  jsii_get_property("sourceConfiguration")
end

#source_configuration=(value) ⇒ Object 



279
280
281
282
283
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 279

def source_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ElasticBeanstalk::CfnConfigurationTemplate::SourceConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljYmVhbnN0YWxrLkNmbkNvbmZpZ3VyYXRpb25UZW1wbGF0ZS5Tb3VyY2VDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "sourceConfiguration") unless value.nil?
  jsii_set_property("sourceConfiguration", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



116
117
118
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 116

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



288
289
290
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 288

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


163
164
165
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 163

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


173
174
175
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 173

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


562
563
564
565
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 562

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


301
302
303
304
305
306
 
# File 'elastic_beanstalk/cfn_configuration_template.rb', line 301

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