Class: AWSCDK::OpsWorks::CfnLayer

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSOpsworks::ILayerRef
Defined in:
ops_works/cfn_layer.rb

Overview

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnLayer

Create a new AWS::OpsWorks::Layer.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::OpsWorks::CfnLayerProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'ops_works/cfn_layer.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::OpsWorks::CfnLayerProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb3Bzd29ya3MuQ2ZuTGF5ZXJQcm9wcyJ9")), "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) 


190
191
192
 
# File 'ops_works/cfn_layer.rb', line 190

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

.is_cfn_layer(x) ⇒ Boolean

Checks whether the given object is a CfnLayer.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


92
93
94
95
 
# File 'ops_works/cfn_layer.rb', line 92

def self.is_cfn_layer(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_opsworks.CfnLayer", "isCfnLayer", [x])
end

.jsii_overridable_methods ⇒ Object 



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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'ops_works/cfn_layer.rb', line 26

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_id => { kind: :property, name: "attrId", is_optional: false },
    :layer_ref => { kind: :property, name: "layerRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :auto_assign_elastic_ips => { kind: :property, name: "autoAssignElasticIps", is_optional: false },
    :auto_assign_public_ips => { kind: :property, name: "autoAssignPublicIps", is_optional: false },
    :custom_json => { kind: :property, name: "customJson", is_optional: false },
    :enable_auto_healing => { kind: :property, name: "enableAutoHealing", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :shortname => { kind: :property, name: "shortname", is_optional: false },
    :stack_id => { kind: :property, name: "stackId", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :attributes => { kind: :property, name: "attributes", is_optional: true },
    :custom_instance_profile_arn => { kind: :property, name: "customInstanceProfileArn", is_optional: true },
    :custom_recipes => { kind: :property, name: "customRecipes", is_optional: true },
    :custom_security_group_ids => { kind: :property, name: "customSecurityGroupIds", is_optional: true },
    :install_updates_on_boot => { kind: :property, name: "installUpdatesOnBoot", is_optional: true },
    :lifecycle_event_configuration => { kind: :property, name: "lifecycleEventConfiguration", is_optional: true },
    :load_based_auto_scaling => { kind: :property, name: "loadBasedAutoScaling", is_optional: true },
    :packages => { kind: :property, name: "packages", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :use_ebs_optimized_instances => { kind: :property, name: "useEbsOptimizedInstances", is_optional: true },
    :volume_configurations => { kind: :property, name: "volumeConfigurations", 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.



481
482
483
484
 
# File 'ops_works/cfn_layer.rb', line 481

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:



493
494
495
496
 
# File 'ops_works/cfn_layer.rb', line 493

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:



503
504
505
506
 
# File 'ops_works/cfn_layer.rb', line 503

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:



514
515
516
517
518
 
# File 'ops_works/cfn_layer.rb', line 514

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.


571
572
573
574
575
 
# File 'ops_works/cfn_layer.rb', line 571

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.



581
582
583
584
 
# File 'ops_works/cfn_layer.rb', line 581

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.



593
594
595
596
597
 
# File 'ops_works/cfn_layer.rb', line 593

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

#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:



606
607
608
609
 
# File 'ops_works/cfn_layer.rb', line 606

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:



628
629
630
631
632
633
 
# File 'ops_works/cfn_layer.rb', line 628

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_id ⇒ String

Returns:

  • (String) 


195
196
197
 
# File 'ops_works/cfn_layer.rb', line 195

def attr_id()
  jsii_get_property("attrId")
end

#attributes ⇒ AWSCDK::IResolvable, ...

One or more user-defined key-value pairs to be added to the stack attributes.

Returns:



312
313
314
 
# File 'ops_works/cfn_layer.rb', line 312

def attributes()
  jsii_get_property("attributes")
end

#attributes=(value) ⇒ Object 



316
317
318
319
 
# File 'ops_works/cfn_layer.rb', line 316

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

#auto_assign_elastic_ips ⇒ Boolean, AWSCDK::IResolvable

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer .

Returns:



216
217
218
 
# File 'ops_works/cfn_layer.rb', line 216

def auto_assign_elastic_ips()
  jsii_get_property("autoAssignElasticIps")
end

#auto_assign_elastic_ips=(value) ⇒ Object 



220
221
222
223
 
# File 'ops_works/cfn_layer.rb', line 220

def auto_assign_elastic_ips=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "autoAssignElasticIps")
  jsii_set_property("autoAssignElasticIps", value)
end

#auto_assign_public_ips ⇒ Boolean, AWSCDK::IResolvable

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.

Returns:



228
229
230
 
# File 'ops_works/cfn_layer.rb', line 228

def auto_assign_public_ips()
  jsii_get_property("autoAssignPublicIps")
end

#auto_assign_public_ips=(value) ⇒ Object 



232
233
234
235
 
# File 'ops_works/cfn_layer.rb', line 232

def auto_assign_public_ips=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "autoAssignPublicIps")
  jsii_set_property("autoAssignPublicIps", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



143
144
145
 
# File 'ops_works/cfn_layer.rb', line 143

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


148
149
150
 
# File 'ops_works/cfn_layer.rb', line 148

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


637
638
639
640
 
# File 'ops_works/cfn_layer.rb', line 637

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}) 


153
154
155
 
# File 'ops_works/cfn_layer.rb', line 153

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


160
161
162
 
# File 'ops_works/cfn_layer.rb', line 160

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


105
106
107
 
# File 'ops_works/cfn_layer.rb', line 105

def creation_stack()
  jsii_get_property("creationStack")
end

#custom_instance_profile_arn ⇒ String?

The ARN of an IAM profile to be used for the layer's EC2 instances.

Returns:

  • (String, nil) 


324
325
326
 
# File 'ops_works/cfn_layer.rb', line 324

def custom_instance_profile_arn()
  jsii_get_property("customInstanceProfileArn")
end

#custom_instance_profile_arn=(value) ⇒ Object 



328
329
330
331
 
# File 'ops_works/cfn_layer.rb', line 328

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

#custom_json ⇒ Object

A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances.

Returns:

  • (Object) 


240
241
242
 
# File 'ops_works/cfn_layer.rb', line 240

def custom_json()
  jsii_get_property("customJson")
end

#custom_json=(value) ⇒ Object 



244
245
246
247
 
# File 'ops_works/cfn_layer.rb', line 244

def custom_json=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "customJson")
  jsii_set_property("customJson", value)
end

#custom_recipes ⇒ AWSCDK::IResolvable, ...

A LayerCustomRecipes object that specifies the layer custom recipes.

Returns:



336
337
338
 
# File 'ops_works/cfn_layer.rb', line 336

def custom_recipes()
  jsii_get_property("customRecipes")
end

#custom_recipes=(value) ⇒ Object 



340
341
342
343
344
 
# File 'ops_works/cfn_layer.rb', line 340

def custom_recipes=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpsWorks::CfnLayer::RecipesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcHN3b3Jrcy5DZm5MYXllci5SZWNpcGVzUHJvcGVydHkifV19fQ==")), "customRecipes") unless value.nil?
  jsii_set_property("customRecipes", value)
end

#custom_security_group_ids ⇒ Array<String>?

An array containing the layer custom security group IDs.

Returns:

  • (Array<String>, nil) 


349
350
351
 
# File 'ops_works/cfn_layer.rb', line 349

def custom_security_group_ids()
  jsii_get_property("customSecurityGroupIds")
end

#custom_security_group_ids=(value) ⇒ Object 



353
354
355
356
 
# File 'ops_works/cfn_layer.rb', line 353

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

#enable_auto_healing ⇒ Boolean, AWSCDK::IResolvable

Whether to disable auto healing for the layer.

Returns:



252
253
254
 
# File 'ops_works/cfn_layer.rb', line 252

def enable_auto_healing()
  jsii_get_property("enableAutoHealing")
end

#enable_auto_healing=(value) ⇒ Object 



256
257
258
259
 
# File 'ops_works/cfn_layer.rb', line 256

def enable_auto_healing=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableAutoHealing")
  jsii_set_property("enableAutoHealing", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



165
166
167
 
# File 'ops_works/cfn_layer.rb', line 165

def env()
  jsii_get_property("env")
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:



650
651
652
653
654
 
# File 'ops_works/cfn_layer.rb', line 650

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:



661
662
663
664
 
# File 'ops_works/cfn_layer.rb', line 661

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:



731
732
733
734
 
# File 'ops_works/cfn_layer.rb', line 731

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

#install_updates_on_boot ⇒ Boolean, ...

Whether to install operating system and package updates when the instance boots.

Returns:



361
362
363
 
# File 'ops_works/cfn_layer.rb', line 361

def install_updates_on_boot()
  jsii_get_property("installUpdatesOnBoot")
end

#install_updates_on_boot=(value) ⇒ Object 



365
366
367
368
 
# File 'ops_works/cfn_layer.rb', line 365

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

#layer_ref ⇒ AWSCDK::Interfaces::AWSOpsworks::LayerReference

A reference to a Layer resource.

Returns:



202
203
204
 
# File 'ops_works/cfn_layer.rb', line 202

def layer_ref()
  jsii_get_property("layerRef")
end

#lifecycle_event_configuration ⇒ AWSCDK::IResolvable, ...

A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

Returns:



373
374
375
 
# File 'ops_works/cfn_layer.rb', line 373

def lifecycle_event_configuration()
  jsii_get_property("lifecycleEventConfiguration")
end

#lifecycle_event_configuration=(value) ⇒ Object 



377
378
379
380
381
 
# File 'ops_works/cfn_layer.rb', line 377

def lifecycle_event_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpsWorks::CfnLayer::LifecycleEventConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcHN3b3Jrcy5DZm5MYXllci5MaWZlY3ljbGVFdmVudENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "lifecycleEventConfiguration") unless value.nil?
  jsii_set_property("lifecycleEventConfiguration", value)
end

#load_based_auto_scaling ⇒ AWSCDK::IResolvable, ...

The load-based scaling configuration for the OpsWorks layer.

Returns:



386
387
388
 
# File 'ops_works/cfn_layer.rb', line 386

def load_based_auto_scaling()
  jsii_get_property("loadBasedAutoScaling")
end

#load_based_auto_scaling=(value) ⇒ Object 



390
391
392
393
394
 
# File 'ops_works/cfn_layer.rb', line 390

def load_based_auto_scaling=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpsWorks::CfnLayer::LoadBasedAutoScalingProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcHN3b3Jrcy5DZm5MYXllci5Mb2FkQmFzZWRBdXRvU2NhbGluZ1Byb3BlcnR5In1dfX0=")), "loadBasedAutoScaling") unless value.nil?
  jsii_set_property("loadBasedAutoScaling", value)
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) 


117
118
119
 
# File 'ops_works/cfn_layer.rb', line 117

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The layer name, which is used by the console.

Returns:

  • (String) 


264
265
266
 
# File 'ops_works/cfn_layer.rb', line 264

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



268
269
270
271
 
# File 'ops_works/cfn_layer.rb', line 268

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


100
101
102
 
# File 'ops_works/cfn_layer.rb', line 100

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:



672
673
674
 
# File 'ops_works/cfn_layer.rb', line 672

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:



679
680
681
 
# File 'ops_works/cfn_layer.rb', line 679

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
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.



472
473
474
475
 
# File 'ops_works/cfn_layer.rb', line 472

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

#packages ⇒ Array<String>?

An array of Package objects that describes the layer packages.

Returns:

  • (Array<String>, nil) 


399
400
401
 
# File 'ops_works/cfn_layer.rb', line 399

def packages()
  jsii_get_property("packages")
end

#packages=(value) ⇒ Object 



403
404
405
406
 
# File 'ops_works/cfn_layer.rb', line 403

def packages=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "packages") unless value.nil?
  jsii_set_property("packages", 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) 


136
137
138
 
# File 'ops_works/cfn_layer.rb', line 136

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:



690
691
692
693
 
# File 'ops_works/cfn_layer.rb', line 690

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}) 


697
698
699
700
 
# File 'ops_works/cfn_layer.rb', line 697

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:



707
708
709
710
711
 
# File 'ops_works/cfn_layer.rb', line 707

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

#shortname ⇒ String

For custom layers only, use this parameter to specify the layer's short name, which is used internally by OpsWorks Stacks and by Chef recipes.

Returns:

  • (String) 


276
277
278
 
# File 'ops_works/cfn_layer.rb', line 276

def shortname()
  jsii_get_property("shortname")
end

#shortname=(value) ⇒ Object 



280
281
282
283
 
# File 'ops_works/cfn_layer.rb', line 280

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



716
717
718
 
# File 'ops_works/cfn_layer.rb', line 716

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



126
127
128
 
# File 'ops_works/cfn_layer.rb', line 126

def stack()
  jsii_get_property("stack")
end

#stack_id ⇒ String

The layer stack ID.

Returns:

  • (String) 


288
289
290
 
# File 'ops_works/cfn_layer.rb', line 288

def stack_id()
  jsii_get_property("stackId")
end

#stack_id=(value) ⇒ Object 



292
293
294
295
 
# File 'ops_works/cfn_layer.rb', line 292

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



209
210
211
 
# File 'ops_works/cfn_layer.rb', line 209

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Specifies one or more sets of tags (key–value pairs) to associate with this OpsWorks layer.

Returns:



411
412
413
 
# File 'ops_works/cfn_layer.rb', line 411

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



415
416
417
418
419
 
# File 'ops_works/cfn_layer.rb', line 415

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



448
449
450
 
# File 'ops_works/cfn_layer.rb', line 448

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

#type ⇒ String

The layer type.

Returns:

  • (String) 


300
301
302
 
# File 'ops_works/cfn_layer.rb', line 300

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



304
305
306
307
 
# File 'ops_works/cfn_layer.rb', line 304

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


173
174
175
 
# File 'ops_works/cfn_layer.rb', line 173

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}) 


183
184
185
 
# File 'ops_works/cfn_layer.rb', line 183

def updated_properties()
  jsii_get_property("updatedProperties")
end

#use_ebs_optimized_instances ⇒ Boolean, ...

Whether to use Amazon EBS-optimized instances.

Returns:



424
425
426
 
# File 'ops_works/cfn_layer.rb', line 424

def use_ebs_optimized_instances()
  jsii_get_property("useEbsOptimizedInstances")
end

#use_ebs_optimized_instances=(value) ⇒ Object 



428
429
430
431
 
# File 'ops_works/cfn_layer.rb', line 428

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

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


722
723
724
725
 
# File 'ops_works/cfn_layer.rb', line 722

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#volume_configurations ⇒ AWSCDK::IResolvable, ...

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

Returns:



436
437
438
 
# File 'ops_works/cfn_layer.rb', line 436

def volume_configurations()
  jsii_get_property("volumeConfigurations")
end

#volume_configurations=(value) ⇒ Object 



440
441
442
443
 
# File 'ops_works/cfn_layer.rb', line 440

def volume_configurations=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb3Bzd29ya3MuQ2ZuTGF5ZXIuVm9sdW1lQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "volumeConfigurations") unless value.nil?
  jsii_set_property("volumeConfigurations", value)
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) 


461
462
463
464
465
466
 
# File 'ops_works/cfn_layer.rb', line 461

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