Class: AWSCDK::Lightsail::CfnInstance

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSLightsail::IInstanceRef
Defined in:
lightsail/cfn_instance.rb

Overview

The AWS::Lightsail::Instance resource specifies an Amazon Lightsail instance.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnInstance

Create a new AWS::Lightsail::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::Lightsail::CfnInstanceProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'lightsail/cfn_instance.rb', line 18

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

Class Method Details

.arn_for_instance(resource) ⇒ String

Parameters:

Returns:

  • (String) 


98
99
100
101
 
# File 'lightsail/cfn_instance.rb', line 98

def self.arn_for_instance(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19saWdodHNhaWwuSUluc3RhbmNlUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lightsail.CfnInstance", "arnForInstance", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


205
206
207
 
# File 'lightsail/cfn_instance.rb', line 205

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

.is_cfn_instance(x) ⇒ Boolean

Checks whether the given object is a CfnInstance.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


107
108
109
110
 
# File 'lightsail/cfn_instance.rb', line 107

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_lightsail.CfnInstance", "isCfnInstance", [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
87
88
89
90
91
92
93
94
 
# File 'lightsail/cfn_instance.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_hardware_cpu_count => { kind: :property, name: "attrHardwareCpuCount", is_optional: false },
    :attr_hardware_ram_size_in_gb => { kind: :property, name: "attrHardwareRamSizeInGb", is_optional: false },
    :attr_instance_arn => { kind: :property, name: "attrInstanceArn", is_optional: false },
    :attr_ipv6_addresses => { kind: :property, name: "attrIpv6Addresses", is_optional: false },
    :attr_is_static_ip => { kind: :property, name: "attrIsStaticIp", is_optional: false },
    :attr_location_availability_zone => { kind: :property, name: "attrLocationAvailabilityZone", is_optional: false },
    :attr_location_region_name => { kind: :property, name: "attrLocationRegionName", is_optional: false },
    :attr_networking_monthly_transfer_gb_per_month_allocated => { kind: :property, name: "attrNetworkingMonthlyTransferGbPerMonthAllocated", is_optional: false },
    :attr_private_ip_address => { kind: :property, name: "attrPrivateIpAddress", is_optional: false },
    :attr_public_ip_address => { kind: :property, name: "attrPublicIpAddress", is_optional: false },
    :attr_resource_type => { kind: :property, name: "attrResourceType", is_optional: false },
    :attr_ssh_key_name => { kind: :property, name: "attrSshKeyName", is_optional: false },
    :attr_state_code => { kind: :property, name: "attrStateCode", is_optional: false },
    :attr_state_name => { kind: :property, name: "attrStateName", is_optional: false },
    :attr_support_code => { kind: :property, name: "attrSupportCode", is_optional: false },
    :attr_user_name => { kind: :property, name: "attrUserName", is_optional: false },
    :instance_ref => { kind: :property, name: "instanceRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :blueprint_id => { kind: :property, name: "blueprintId", is_optional: false },
    :bundle_id => { kind: :property, name: "bundleId", is_optional: false },
    :instance_name => { kind: :property, name: "instanceName", is_optional: false },
    :add_ons => { kind: :property, name: "addOns", is_optional: true },
    :availability_zone => { kind: :property, name: "availabilityZone", is_optional: true },
    :hardware => { kind: :property, name: "hardware", is_optional: true },
    :key_pair_name => { kind: :property, name: "keyPairName", is_optional: true },
    :location => { kind: :property, name: "location", is_optional: true },
    :networking => { kind: :property, name: "networking", is_optional: true },
    :state => { kind: :property, name: "state", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :user_data => { kind: :property, name: "userData", 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.



522
523
524
525
 
# File 'lightsail/cfn_instance.rb', line 522

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:



534
535
536
537
 
# File 'lightsail/cfn_instance.rb', line 534

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:



544
545
546
547
 
# File 'lightsail/cfn_instance.rb', line 544

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:



555
556
557
558
559
 
# File 'lightsail/cfn_instance.rb', line 555

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_ons ⇒ AWSCDK::IResolvable, ...

An array of add-ons for the instance.

Returns:



376
377
378
 
# File 'lightsail/cfn_instance.rb', line 376

def add_ons()
  jsii_get_property("addOns")
end

#add_ons=(value) ⇒ Object 



380
381
382
383
 
# File 'lightsail/cfn_instance.rb', line 380

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


612
613
614
615
616
 
# File 'lightsail/cfn_instance.rb', line 612

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.



622
623
624
625
 
# File 'lightsail/cfn_instance.rb', line 622

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.



634
635
636
637
638
 
# File 'lightsail/cfn_instance.rb', line 634

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:



647
648
649
650
 
# File 'lightsail/cfn_instance.rb', line 647

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:



669
670
671
672
673
674
 
# File 'lightsail/cfn_instance.rb', line 669

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_hardware_cpu_count ⇒ Numeric

The number of vCPUs the instance has.

Returns:

  • (Numeric) 


212
213
214
 
# File 'lightsail/cfn_instance.rb', line 212

def attr_hardware_cpu_count()
  jsii_get_property("attrHardwareCpuCount")
end

#attr_hardware_ram_size_in_gb ⇒ Numeric

The amount of RAM in GB on the instance (for example, 1.0 ).

Returns:

  • (Numeric) 


219
220
221
 
# File 'lightsail/cfn_instance.rb', line 219

def attr_hardware_ram_size_in_gb()
  jsii_get_property("attrHardwareRamSizeInGb")
end

#attr_instance_arn ⇒ String

The Amazon Resource Name (ARN) of the instance (for example, arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE ).

Returns:

  • (String) 


226
227
228
 
# File 'lightsail/cfn_instance.rb', line 226

def attr_instance_arn()
  jsii_get_property("attrInstanceArn")
end

#attr_ipv6_addresses ⇒ Array<String>

The IPv6 addresses of the instance.

Returns:

  • (Array<String>) 


233
234
235
 
# File 'lightsail/cfn_instance.rb', line 233

def attr_ipv6_addresses()
  jsii_get_property("attrIpv6Addresses")
end

#attr_is_static_ip ⇒ AWSCDK::IResolvable

A Boolean value indicating whether the instance has a static IP assigned to it.

Returns:



240
241
242
 
# File 'lightsail/cfn_instance.rb', line 240

def attr_is_static_ip()
  jsii_get_property("attrIsStaticIp")
end

#attr_location_availability_zone ⇒ String

The AWS Region and Availability Zone where the instance is located.

Returns:

  • (String) 


247
248
249
 
# File 'lightsail/cfn_instance.rb', line 247

def attr_location_availability_zone()
  jsii_get_property("attrLocationAvailabilityZone")
end

#attr_location_region_name ⇒ String

The AWS Region of the instance.

Returns:

  • (String) 


254
255
256
 
# File 'lightsail/cfn_instance.rb', line 254

def attr_location_region_name()
  jsii_get_property("attrLocationRegionName")
end

#attr_networking_monthly_transfer_gb_per_month_allocated ⇒ String

The amount of allocated monthly data transfer (in GB) for an instance.

Returns:

  • (String) 


261
262
263
 
# File 'lightsail/cfn_instance.rb', line 261

def attr_networking_monthly_transfer_gb_per_month_allocated()
  jsii_get_property("attrNetworkingMonthlyTransferGbPerMonthAllocated")
end

#attr_private_ip_address ⇒ String

The private IP address of the instance.

Returns:

  • (String) 


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

def attr_private_ip_address()
  jsii_get_property("attrPrivateIpAddress")
end

#attr_public_ip_address ⇒ String

The public IP address of the instance.

Returns:

  • (String) 


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

def attr_public_ip_address()
  jsii_get_property("attrPublicIpAddress")
end

#attr_resource_type ⇒ String

The resource type of the instance (for example, Instance ).

Returns:

  • (String) 


282
283
284
 
# File 'lightsail/cfn_instance.rb', line 282

def attr_resource_type()
  jsii_get_property("attrResourceType")
end

#attr_ssh_key_name ⇒ String

The name of the SSH key pair used by the instance.

Returns:

  • (String) 


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

def attr_ssh_key_name()
  jsii_get_property("attrSshKeyName")
end

#attr_state_code ⇒ Numeric

The status code of the instance.

Returns:

  • (Numeric) 


296
297
298
 
# File 'lightsail/cfn_instance.rb', line 296

def attr_state_code()
  jsii_get_property("attrStateCode")
end

#attr_state_name ⇒ String

The state of the instance (for example, running or pending ).

Returns:

  • (String) 


303
304
305
 
# File 'lightsail/cfn_instance.rb', line 303

def attr_state_name()
  jsii_get_property("attrStateName")
end

#attr_support_code ⇒ String

The support code of the instance.

Include this code in your email to support when you have questions about an instance or another resource in Lightsail . This code helps our support team to look up your Lightsail information.

Returns:

  • (String) 


312
313
314
 
# File 'lightsail/cfn_instance.rb', line 312

def attr_support_code()
  jsii_get_property("attrSupportCode")
end

#attr_user_name ⇒ String

The user name for connecting to the instance (for example, ec2-user ).

Returns:

  • (String) 


319
320
321
 
# File 'lightsail/cfn_instance.rb', line 319

def attr_user_name()
  jsii_get_property("attrUserName")
end

#availability_zone ⇒ String?

The Availability Zone for the instance.

Returns:

  • (String, nil) 


388
389
390
 
# File 'lightsail/cfn_instance.rb', line 388

def availability_zone()
  jsii_get_property("availabilityZone")
end

#availability_zone=(value) ⇒ Object 



392
393
394
395
 
# File 'lightsail/cfn_instance.rb', line 392

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

#blueprint_id ⇒ String

The blueprint ID for the instance (for example, os_amlinux_2016_03 ).

Returns:

  • (String) 


340
341
342
 
# File 'lightsail/cfn_instance.rb', line 340

def blueprint_id()
  jsii_get_property("blueprintId")
end

#blueprint_id=(value) ⇒ Object 



344
345
346
347
 
# File 'lightsail/cfn_instance.rb', line 344

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

#bundle_id ⇒ String

The bundle ID for the instance (for example, micro_1_0 ).

Returns:

  • (String) 


352
353
354
 
# File 'lightsail/cfn_instance.rb', line 352

def bundle_id()
  jsii_get_property("bundleId")
end

#bundle_id=(value) ⇒ Object 



356
357
358
359
 
# File 'lightsail/cfn_instance.rb', line 356

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


163
164
165
 
# File 'lightsail/cfn_instance.rb', line 163

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


678
679
680
681
 
# File 'lightsail/cfn_instance.rb', line 678

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


168
169
170
 
# File 'lightsail/cfn_instance.rb', line 168

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


175
176
177
 
# File 'lightsail/cfn_instance.rb', line 175

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


120
121
122
 
# File 'lightsail/cfn_instance.rb', line 120

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



180
181
182
 
# File 'lightsail/cfn_instance.rb', line 180

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:



691
692
693
694
695
 
# File 'lightsail/cfn_instance.rb', line 691

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:



702
703
704
705
 
# File 'lightsail/cfn_instance.rb', line 702

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

#hardware ⇒ AWSCDK::IResolvable, ...

The hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.

Returns:



400
401
402
 
# File 'lightsail/cfn_instance.rb', line 400

def hardware()
  jsii_get_property("hardware")
end

#hardware=(value) ⇒ Object 



404
405
406
407
408
 
# File 'lightsail/cfn_instance.rb', line 404

def hardware=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lightsail::CfnInstance::HardwareProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19saWdodHNhaWwuQ2ZuSW5zdGFuY2UuSGFyZHdhcmVQcm9wZXJ0eSJ9XX19")), "hardware") unless value.nil?
  jsii_set_property("hardware", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



772
773
774
775
 
# File 'lightsail/cfn_instance.rb', line 772

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

#instance_name ⇒ String

The name of the instance.

Returns:

  • (String) 


364
365
366
 
# File 'lightsail/cfn_instance.rb', line 364

def instance_name()
  jsii_get_property("instanceName")
end

#instance_name=(value) ⇒ Object 



368
369
370
371
 
# File 'lightsail/cfn_instance.rb', line 368

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

#instance_ref ⇒ AWSCDK::Interfaces::AWSLightsail::InstanceReference

A reference to a Instance resource.

Returns:



326
327
328
 
# File 'lightsail/cfn_instance.rb', line 326

def instance_ref()
  jsii_get_property("instanceRef")
end

#key_pair_name ⇒ String?

The name of the key pair to use for the instance.

Returns:

  • (String, nil) 


413
414
415
 
# File 'lightsail/cfn_instance.rb', line 413

def key_pair_name()
  jsii_get_property("keyPairName")
end

#key_pair_name=(value) ⇒ Object 



417
418
419
420
 
# File 'lightsail/cfn_instance.rb', line 417

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

#location ⇒ AWSCDK::IResolvable, ...

The location for the instance, such as the AWS Region and Availability Zone.

Returns:



425
426
427
 
# File 'lightsail/cfn_instance.rb', line 425

def location()
  jsii_get_property("location")
end

#location=(value) ⇒ Object 



429
430
431
432
433
 
# File 'lightsail/cfn_instance.rb', line 429

def location=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lightsail::CfnInstance::LocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19saWdodHNhaWwuQ2ZuSW5zdGFuY2UuTG9jYXRpb25Qcm9wZXJ0eSJ9XX19")), "location") unless value.nil?
  jsii_set_property("location", 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) 


132
133
134
 
# File 'lightsail/cfn_instance.rb', line 132

def logical_id()
  jsii_get_property("logicalId")
end

#networking ⇒ AWSCDK::IResolvable, ...

The public ports and the monthly amount of data transfer allocated for the instance.

Returns:



438
439
440
 
# File 'lightsail/cfn_instance.rb', line 438

def networking()
  jsii_get_property("networking")
end

#networking=(value) ⇒ Object 



442
443
444
445
446
 
# File 'lightsail/cfn_instance.rb', line 442

def networking=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lightsail::CfnInstance::NetworkingProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19saWdodHNhaWwuQ2ZuSW5zdGFuY2UuTmV0d29ya2luZ1Byb3BlcnR5In1dfX0=")), "networking") unless value.nil?
  jsii_set_property("networking", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


115
116
117
 
# File 'lightsail/cfn_instance.rb', line 115

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:



713
714
715
 
# File 'lightsail/cfn_instance.rb', line 713

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:



720
721
722
 
# File 'lightsail/cfn_instance.rb', line 720

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.



513
514
515
516
 
# File 'lightsail/cfn_instance.rb', line 513

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) 


151
152
153
 
# File 'lightsail/cfn_instance.rb', line 151

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:



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

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


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

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:



748
749
750
751
752
 
# File 'lightsail/cfn_instance.rb', line 748

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.



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

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:



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

def stack()
  jsii_get_property("stack")
end

#state ⇒ AWSCDK::IResolvable, ...

The status code and the state (for example, running ) of the instance.

Returns:



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

def state()
  jsii_get_property("state")
end

#state=(value) ⇒ Object 



455
456
457
458
459
 
# File 'lightsail/cfn_instance.rb', line 455

def state=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lightsail::CfnInstance::StateProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19saWdodHNhaWwuQ2ZuSW5zdGFuY2UuU3RhdGVQcm9wZXJ0eSJ9XX19")), "state") unless value.nil?
  jsii_set_property("state", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



333
334
335
 
# File 'lightsail/cfn_instance.rb', line 333

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

An array of key-value pairs to apply to this resource.

Returns:



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

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



468
469
470
471
472
 
# File 'lightsail/cfn_instance.rb', line 468

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



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

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


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

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


198
199
200
 
# File 'lightsail/cfn_instance.rb', line 198

def updated_properties()
  jsii_get_property("updatedProperties")
end

#user_data ⇒ String?

The optional launch script for the instance.

Returns:

  • (String, nil) 


477
478
479
 
# File 'lightsail/cfn_instance.rb', line 477

def user_data()
  jsii_get_property("userData")
end

#user_data=(value) ⇒ Object 



481
482
483
484
 
# File 'lightsail/cfn_instance.rb', line 481

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

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


763
764
765
766
 
# File 'lightsail/cfn_instance.rb', line 763

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) 


502
503
504
505
506
507
 
# File 'lightsail/cfn_instance.rb', line 502

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