Class: AWSCDK::OpsWorks::CfnInstance

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSOpsworks::IInstanceRef
Defined in:
ops_works/cfn_instance.rb

Overview

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

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnInstance

Create a new AWS::OpsWorks::Instance.

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::CfnInstanceProps) —

    Resource properties.



17
18
19
20
21
22
23
 
# File 'ops_works/cfn_instance.rb', line 17

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


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

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

.is_cfn_instance(x) ⇒ Boolean

Checks whether the given object is a CfnInstance.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


97
98
99
100
 
# File 'ops_works/cfn_instance.rb', line 97

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

.jsii_overridable_methods ⇒ Object 



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
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
87
88
89
90
91
 
# File 'ops_works/cfn_instance.rb', line 25

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_availability_zone => { kind: :property, name: "attrAvailabilityZone", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_private_dns_name => { kind: :property, name: "attrPrivateDnsName", is_optional: false },
    :attr_private_ip => { kind: :property, name: "attrPrivateIp", is_optional: false },
    :attr_public_dns_name => { kind: :property, name: "attrPublicDnsName", is_optional: false },
    :attr_public_ip => { kind: :property, name: "attrPublicIp", is_optional: false },
    :instance_ref => { kind: :property, name: "instanceRef", is_optional: false },
    :instance_type => { kind: :property, name: "instanceType", is_optional: false },
    :layer_ids => { kind: :property, name: "layerIds", is_optional: false },
    :stack_id => { kind: :property, name: "stackId", is_optional: false },
    :agent_version => { kind: :property, name: "agentVersion", is_optional: true },
    :ami_id => { kind: :property, name: "amiId", is_optional: true },
    :architecture => { kind: :property, name: "architecture", is_optional: true },
    :auto_scaling_type => { kind: :property, name: "autoScalingType", is_optional: true },
    :availability_zone => { kind: :property, name: "availabilityZone", is_optional: true },
    :block_device_mappings => { kind: :property, name: "blockDeviceMappings", is_optional: true },
    :ebs_optimized => { kind: :property, name: "ebsOptimized", is_optional: true },
    :elastic_ips => { kind: :property, name: "elasticIps", is_optional: true },
    :hostname => { kind: :property, name: "hostname", is_optional: true },
    :install_updates_on_boot => { kind: :property, name: "installUpdatesOnBoot", is_optional: true },
    :os => { kind: :property, name: "os", is_optional: true },
    :root_device_type => { kind: :property, name: "rootDeviceType", is_optional: true },
    :ssh_key_name => { kind: :property, name: "sshKeyName", is_optional: true },
    :subnet_id => { kind: :property, name: "subnetId", is_optional: true },
    :tenancy => { kind: :property, name: "tenancy", is_optional: true },
    :time_based_auto_scaling => { kind: :property, name: "timeBasedAutoScaling", is_optional: true },
    :virtualization_type => { kind: :property, name: "virtualizationType", is_optional: true },
    :volumes => { kind: :property, name: "volumes", 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.



541
542
543
544
 
# File 'ops_works/cfn_instance.rb', line 541

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:



553
554
555
556
 
# File 'ops_works/cfn_instance.rb', line 553

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:



563
564
565
566
 
# File 'ops_works/cfn_instance.rb', line 563

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:



574
575
576
577
578
 
# File 'ops_works/cfn_instance.rb', line 574

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.


631
632
633
634
635
 
# File 'ops_works/cfn_instance.rb', line 631

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.



641
642
643
644
 
# File 'ops_works/cfn_instance.rb', line 641

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.



653
654
655
656
657
 
# File 'ops_works/cfn_instance.rb', line 653

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

#agent_version ⇒ String?

The default OpsWorks Stacks agent version.

You have the following options:.

Returns:

  • (String, nil) 


289
290
291
 
# File 'ops_works/cfn_instance.rb', line 289

def agent_version()
  jsii_get_property("agentVersion")
end

#agent_version=(value) ⇒ Object 



293
294
295
296
 
# File 'ops_works/cfn_instance.rb', line 293

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

#ami_id ⇒ String?

A custom AMI ID to be used to create the instance.

Returns:

  • (String, nil) 


301
302
303
 
# File 'ops_works/cfn_instance.rb', line 301

def ami_id()
  jsii_get_property("amiId")
end

#ami_id=(value) ⇒ Object 



305
306
307
308
 
# File 'ops_works/cfn_instance.rb', line 305

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



666
667
668
669
 
# File 'ops_works/cfn_instance.rb', line 666

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:



688
689
690
691
692
693
 
# File 'ops_works/cfn_instance.rb', line 688

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

#architecture ⇒ String?

The instance architecture.

Returns:

  • (String, nil) 


313
314
315
 
# File 'ops_works/cfn_instance.rb', line 313

def architecture()
  jsii_get_property("architecture")
end

#architecture=(value) ⇒ Object 



317
318
319
320
 
# File 'ops_works/cfn_instance.rb', line 317

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

#attr_availability_zone ⇒ String

The Availability Zone of the OpsWorks instance, such as us-east-2a .

Returns:

  • (String) 


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

def attr_availability_zone()
  jsii_get_property("attrAvailabilityZone")
end

#attr_id ⇒ String

Returns:

  • (String) 


207
208
209
 
# File 'ops_works/cfn_instance.rb', line 207

def attr_id()
  jsii_get_property("attrId")
end

#attr_private_dns_name ⇒ String

The private DNS name of the OpsWorks instance.

Returns:

  • (String) 


214
215
216
 
# File 'ops_works/cfn_instance.rb', line 214

def attr_private_dns_name()
  jsii_get_property("attrPrivateDnsName")
end

#attr_private_ip ⇒ String

The private IP address of the OpsWorks instance, such as 192.0.2.0 .

Returns:

  • (String) 


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

def attr_private_ip()
  jsii_get_property("attrPrivateIp")
end

#attr_public_dns_name ⇒ String

The public DNS name of the OpsWorks instance.

Returns:

  • (String) 


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

def attr_public_dns_name()
  jsii_get_property("attrPublicDnsName")
end

#attr_public_ip ⇒ String

The public IP address of the OpsWorks instance, such as 192.0.2.0 .

Use this attribute only when the OpsWorks instance is in an OpsWorks layer that auto-assigns public IP addresses.

Returns:

  • (String) 


237
238
239
 
# File 'ops_works/cfn_instance.rb', line 237

def attr_public_ip()
  jsii_get_property("attrPublicIp")
end

#auto_scaling_type ⇒ String?

For load-based or time-based instances, the type.

Returns:

  • (String, nil) 


325
326
327
 
# File 'ops_works/cfn_instance.rb', line 325

def auto_scaling_type()
  jsii_get_property("autoScalingType")
end

#auto_scaling_type=(value) ⇒ Object 



329
330
331
332
 
# File 'ops_works/cfn_instance.rb', line 329

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

#availability_zone ⇒ String?

The Availability Zone of the OpsWorks instance, such as us-east-2a .

Returns:

  • (String, nil) 


337
338
339
 
# File 'ops_works/cfn_instance.rb', line 337

def availability_zone()
  jsii_get_property("availabilityZone")
end

#availability_zone=(value) ⇒ Object 



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

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

#block_device_mappings ⇒ AWSCDK::IResolvable, ...

An array of BlockDeviceMapping objects that specify the instance's block devices.

Returns:



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

def block_device_mappings()
  jsii_get_property("blockDeviceMappings")
end

#block_device_mappings=(value) ⇒ Object 



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

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


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

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


158
159
160
 
# File 'ops_works/cfn_instance.rb', line 158

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


110
111
112
 
# File 'ops_works/cfn_instance.rb', line 110

def creation_stack()
  jsii_get_property("creationStack")
end

#ebs_optimized ⇒ Boolean, ...

Whether to create an Amazon EBS-optimized instance.

Returns:



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

def ebs_optimized()
  jsii_get_property("ebsOptimized")
end

#ebs_optimized=(value) ⇒ Object 



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

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

#elastic_ips ⇒ Array<String>?

A list of Elastic IP addresses to associate with the instance.

Returns:

  • (Array<String>, nil) 


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

def elastic_ips()
  jsii_get_property("elasticIps")
end

#elastic_ips=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



170
171
172
 
# File 'ops_works/cfn_instance.rb', line 170

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:



710
711
712
713
714
 
# File 'ops_works/cfn_instance.rb', line 710

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:



721
722
723
724
 
# File 'ops_works/cfn_instance.rb', line 721

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

#hostname ⇒ String?

The instance host name.

The following are character limits for instance host names.

Returns:

  • (String, nil) 


387
388
389
 
# File 'ops_works/cfn_instance.rb', line 387

def hostname()
  jsii_get_property("hostname")
end

#hostname=(value) ⇒ Object 



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

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



791
792
793
794
 
# File 'ops_works/cfn_instance.rb', line 791

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:



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

def install_updates_on_boot()
  jsii_get_property("installUpdatesOnBoot")
end

#install_updates_on_boot=(value) ⇒ Object 



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

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

#instance_ref ⇒ AWSCDK::Interfaces::AWSOpsworks::InstanceReference

A reference to a Instance resource.

Returns:



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

def instance_ref()
  jsii_get_property("instanceRef")
end

#instance_type ⇒ String

The instance type, such as t2.micro . For a list of supported instance types, open the stack in the console, choose Instances , and choose + Instance . The Size list contains the currently supported types. For more information, see Instance Families and Types . The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

Returns:

  • (String) 


251
252
253
 
# File 'ops_works/cfn_instance.rb', line 251

def instance_type()
  jsii_get_property("instanceType")
end

#instance_type=(value) ⇒ Object 



255
256
257
258
 
# File 'ops_works/cfn_instance.rb', line 255

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

#layer_ids ⇒ Array<String>

An array that contains the instance's layer IDs.

Returns:

  • (Array<String>) 


263
264
265
 
# File 'ops_works/cfn_instance.rb', line 263

def layer_ids()
  jsii_get_property("layerIds")
end

#layer_ids=(value) ⇒ Object 



267
268
269
270
 
# File 'ops_works/cfn_instance.rb', line 267

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


122
123
124
 
# File 'ops_works/cfn_instance.rb', line 122

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

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:



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

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:



739
740
741
 
# File 'ops_works/cfn_instance.rb', line 739

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

#os ⇒ String?

The instance's operating system, which must be set to one of the following.

Returns:

  • (String, nil) 


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

def os()
  jsii_get_property("os")
end

#os=(value) ⇒ Object 



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

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



532
533
534
535
 
# File 'ops_works/cfn_instance.rb', line 532

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

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


141
142
143
 
# File 'ops_works/cfn_instance.rb', line 141

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:



750
751
752
753
 
# File 'ops_works/cfn_instance.rb', line 750

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


757
758
759
760
 
# File 'ops_works/cfn_instance.rb', line 757

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:



767
768
769
770
771
 
# File 'ops_works/cfn_instance.rb', line 767

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

#root_device_type ⇒ String?

The instance root device type.

Returns:

  • (String, nil) 


423
424
425
 
# File 'ops_works/cfn_instance.rb', line 423

def root_device_type()
  jsii_get_property("rootDeviceType")
end

#root_device_type=(value) ⇒ Object 



427
428
429
430
 
# File 'ops_works/cfn_instance.rb', line 427

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



776
777
778
 
# File 'ops_works/cfn_instance.rb', line 776

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

#ssh_key_name ⇒ String?

The instance's Amazon EC2 key-pair name.

Returns:

  • (String, nil) 


435
436
437
 
# File 'ops_works/cfn_instance.rb', line 435

def ssh_key_name()
  jsii_get_property("sshKeyName")
end

#ssh_key_name=(value) ⇒ Object 



439
440
441
442
 
# File 'ops_works/cfn_instance.rb', line 439

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



131
132
133
 
# File 'ops_works/cfn_instance.rb', line 131

def stack()
  jsii_get_property("stack")
end

#stack_id ⇒ String

The stack ID.

Returns:

  • (String) 


275
276
277
 
# File 'ops_works/cfn_instance.rb', line 275

def stack_id()
  jsii_get_property("stackId")
end

#stack_id=(value) ⇒ Object 



279
280
281
282
 
# File 'ops_works/cfn_instance.rb', line 279

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

#subnet_id ⇒ String?

The ID of the instance's subnet.

Returns:

  • (String, nil) 


447
448
449
 
# File 'ops_works/cfn_instance.rb', line 447

def subnet_id()
  jsii_get_property("subnetId")
end

#subnet_id=(value) ⇒ Object 



451
452
453
454
 
# File 'ops_works/cfn_instance.rb', line 451

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

#tenancy ⇒ String?

The instance's tenancy option.

Returns:

  • (String, nil) 


459
460
461
 
# File 'ops_works/cfn_instance.rb', line 459

def tenancy()
  jsii_get_property("tenancy")
end

#tenancy=(value) ⇒ Object 



463
464
465
466
 
# File 'ops_works/cfn_instance.rb', line 463

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

#time_based_auto_scaling ⇒ AWSCDK::IResolvable, ...

The time-based scaling configuration for the instance.

Returns:



471
472
473
 
# File 'ops_works/cfn_instance.rb', line 471

def time_based_auto_scaling()
  jsii_get_property("timeBasedAutoScaling")
end

#time_based_auto_scaling=(value) ⇒ Object 



475
476
477
478
479
 
# File 'ops_works/cfn_instance.rb', line 475

def time_based_auto_scaling=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpsWorks::CfnInstance::TimeBasedAutoScalingProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcHN3b3Jrcy5DZm5JbnN0YW5jZS5UaW1lQmFzZWRBdXRvU2NhbGluZ1Byb3BlcnR5In1dfX0=")), "timeBasedAutoScaling") unless value.nil?
  jsii_set_property("timeBasedAutoScaling", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



508
509
510
 
# File 'ops_works/cfn_instance.rb', line 508

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


178
179
180
 
# File 'ops_works/cfn_instance.rb', line 178

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


188
189
190
 
# File 'ops_works/cfn_instance.rb', line 188

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


782
783
784
785
 
# File 'ops_works/cfn_instance.rb', line 782

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

#virtualization_type ⇒ String?

The instance's virtualization type, paravirtual or hvm .

Returns:

  • (String, nil) 


484
485
486
 
# File 'ops_works/cfn_instance.rb', line 484

def virtualization_type()
  jsii_get_property("virtualizationType")
end

#virtualization_type=(value) ⇒ Object 



488
489
490
491
 
# File 'ops_works/cfn_instance.rb', line 488

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

#volumes ⇒ Array<String>?

A list of OpsWorks volume IDs to associate with the instance.

Returns:

  • (Array<String>, nil) 


496
497
498
 
# File 'ops_works/cfn_instance.rb', line 496

def volumes()
  jsii_get_property("volumes")
end

#volumes=(value) ⇒ Object 



500
501
502
503
 
# File 'ops_works/cfn_instance.rb', line 500

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


521
522
523
524
525
526
 
# File 'ops_works/cfn_instance.rb', line 521

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