Class: OCI::Core::Models::InstanceConfigurationLaunchInstanceDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/instance_configuration_launch_instance_details.rb

Overview

See Instance launch details - LaunchInstanceDetails

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstanceConfigurationLaunchInstanceDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 238

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']

  raise 'You cannot provide both :availabilityDomain and :availability_domain' if attributes.key?(:'availabilityDomain') && attributes.key?(:'availability_domain')

  self.availability_domain = attributes[:'availability_domain'] if attributes[:'availability_domain']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.create_vnic_details = attributes[:'createVnicDetails'] if attributes[:'createVnicDetails']

  raise 'You cannot provide both :createVnicDetails and :create_vnic_details' if attributes.key?(:'createVnicDetails') && attributes.key?(:'create_vnic_details')

  self.create_vnic_details = attributes[:'create_vnic_details'] if attributes[:'create_vnic_details']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.extended_metadata = attributes[:'extendedMetadata'] if attributes[:'extendedMetadata']

  raise 'You cannot provide both :extendedMetadata and :extended_metadata' if attributes.key?(:'extendedMetadata') && attributes.key?(:'extended_metadata')

  self.extended_metadata = attributes[:'extended_metadata'] if attributes[:'extended_metadata']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.ipxe_script = attributes[:'ipxeScript'] if attributes[:'ipxeScript']

  raise 'You cannot provide both :ipxeScript and :ipxe_script' if attributes.key?(:'ipxeScript') && attributes.key?(:'ipxe_script')

  self.ipxe_script = attributes[:'ipxe_script'] if attributes[:'ipxe_script']

  self.metadata = attributes[:'metadata'] if attributes[:'metadata']

  self.shape = attributes[:'shape'] if attributes[:'shape']

  self.source_details = attributes[:'sourceDetails'] if attributes[:'sourceDetails']

  raise 'You cannot provide both :sourceDetails and :source_details' if attributes.key?(:'sourceDetails') && attributes.key?(:'source_details')

  self.source_details = attributes[:'source_details'] if attributes[:'source_details']

  self.fault_domain = attributes[:'faultDomain'] if attributes[:'faultDomain']

  raise 'You cannot provide both :faultDomain and :fault_domain' if attributes.key?(:'faultDomain') && attributes.key?(:'fault_domain')

  self.fault_domain = attributes[:'fault_domain'] if attributes[:'fault_domain']
end

Instance Attribute Details

#availability_domain ⇒ String

The availability domain of the instance.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 15

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

The OCID of the compartment.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 19

def compartment_id
  @compartment_id
end

#create_vnic_details ⇒ OCI::Core::Models::InstanceConfigurationCreateVnicDetails

Details for the primary VNIC, which is automatically created and attached when the instance is launched.

Returns:



25
26
27
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 25

def create_vnic_details
  @create_vnic_details
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘{"CostCenter": "42"}`

Returns:

  • (Hash<String, Hash<String, Object>>) 


33
34
35
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 33

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Example: ‘My bare metal instance`

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 41

def display_name
  @display_name
end

#extended_metadata ⇒ Hash<String, Object>

Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the ‘metadata’ object.

They are distinguished from ‘metadata’ fields in that these can be nested JSON objects (whereas ‘metadata’ fields are string/string maps only).

Returns:

  • (Hash<String, Object>) 


48
49
50
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 48

def extended_metadata
  @extended_metadata
end

#fault_domain ⇒ String

A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.

If you do not specify the fault domain, the system selects one for you. To change the fault domain for an instance, terminate it and launch a new instance in the preferred fault domain.

To get a list of fault domains, use the list_fault_domains operation in the Identity and Access Management Service API.

Example: ‘FAULT-DOMAIN-1`

Returns:

  • (String) 


178
179
180
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 178

def fault_domain
  @fault_domain
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


56
57
58
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 56

def freeform_tags
  @freeform_tags
end

#ipxe_script ⇒ String

This is an advanced option.

When a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.

If you want more control over the boot process, you can provide your own custom iPXE script that will run when the instance boots; however, you should be aware that the same iPXE script will run every time an instance boots; not only after the initial LaunchInstance call.

The default iPXE script connects to the instance’s local boot volume over iSCSI and performs a network boot. If you use a custom iPXE script and want to network-boot from the instance’s local boot volume over iSCSI the same way as the default iPXE script, you should use the following iSCSI IP address: 169.254.0.2, and boot volume IQN: iqn.2015-02.oracle.boot.

For more information about the Bring Your Own Image feature of Oracle Cloud Infrastructure, see [Bring Your Own Image](docs.cloud.oracle.com/Content/Compute/References/bringyourownimage.htm).

For more information about iPXE, see ipxe.org.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 84

def ipxe_script
  @ipxe_script
end

#metadata ⇒ Hash<String, String>

Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance.

A metadata service runs on every launched instance. The service is an HTTP endpoint listening on 169.254.169.254. You can use the service to:

  • Provide information to [Cloud-Init](cloudinit.readthedocs.org/en/latest/) to be used for various system initialization tasks.

  • Get information about the instance, including the custom metadata that you provide when you launch the instance.

**Providing Cloud-Init Metadata**

You can use the following metadata key names to provide information to
Cloud-Init:

**\"ssh_authorized_keys\"** - Provide one or more public SSH keys to be
included in the `~/.ssh/authorized_keys` file for the default user on the
instance. Use a newline character to separate multiple keys. The SSH
keys must be in the format necessary for the `authorized_keys` file, as shown
in the example below.

**\"user_data\"** - Provide your own base64-encoded data to be used by
Cloud-Init to run custom scripts or provide custom Cloud-Init configuration. For
information about how to take advantage of user data, see the
[Cloud-Init Documentation](http://cloudinit.readthedocs.org/en/latest/topics/format.html).

**Note:** Cloud-Init does not pull this data from the `http://169.254.169.254/opc/v1/instance/metadata/`
path. When the instance launches and either of these keys are provided, the key values are formatted as
OpenStack metadata and copied to the following locations, which are recognized by Cloud-Init:

`http://169.254.169.254/openstack/latest/meta_data.json` - This JSON blob
contains, among other things, the SSH keys that you provided for
 **\"ssh_authorized_keys\"**.

`http://169.254.169.254/openstack/latest/user_data` - Contains the
base64-decoded data that you provided for **\"user_data\"**.

**Metadata Example**

     \"metadata\" : {
        \"quake_bot_level\" : \"Severe\",
        \"ssh_authorized_keys\" : \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCZ06fccNTQfq+xubFlJ5ZR3kt+uzspdH9tXL+lAejSM1NXM+CFZev7MIxfEjas06y80ZBZ7DUTQO0GxJPeD8NCOb1VorF8M4xuLwrmzRtkoZzU16umt4y1W0Q4ifdp3IiiU0U8/WxczSXcUVZOLqkz5dc6oMHdMVpkimietWzGZ4LBBsH/LjEVY7E0V+a0sNchlVDIZcm7ErReBLcdTGDq0uLBiuChyl6RUkX1PNhusquTGwK7zc8OBXkRuubn5UKXhI3Ul9Nyk4XESkVWIGNKmw8mSpoJSjR8P9ZjRmcZVo8S+x4KVPMZKQEor== [email protected]
        ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAzJSAtwEPoB3Jmr58IXrDGzLuDYkWAYg8AsLYlo6JZvKpjY1xednIcfEVQJm4T2DhVmdWhRrwQ8DmayVZvBkLt+zs2LdoAJEVimKwXcJFD/7wtH8Lnk17HiglbbbNXsemjDY0hea4JUE5CfvkIdZBITuMrfqSmA4n3VNoorXYdvtTMoGG8fxMub46RPtuxtqi9bG9Zqenordkg5FJt2mVNfQRqf83CWojcOkklUWq4CjyxaeLf5i9gv1fRoBo4QhiA8I6NCSppO8GnoV/6Ox6TNoh9BiifqGKC9VGYuC89RvUajRBTZSK2TK4DPfaT+2R+slPsFrwiT/oPEhhEK1S5Q== rsa-key-20160227\",
        \"user_data\" : \"SWYgeW91IGNhbiBzZWUgdGhpcywgdGhlbiBpdCB3b3JrZWQgbWF5YmUuCg==\"
     }
**Getting Metadata on the Instance**

To get information about your instance, connect to the instance using SSH and issue any of the
following GET requests:

    curl http://169.254.169.254/opc/v1/instance/
    curl http://169.254.169.254/opc/v1/instance/metadata/
    curl http://169.254.169.254/opc/v1/instance/metadata/<any-key-name>

You'll get back a response that includes all the instance information; only the metadata information; or
the metadata information for the specified key name, respectively.

Returns:

  • (Hash<String, String>) 


146
147
148
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 146

def metadata
  @metadata
end

#shape ⇒ String

The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.

You can enumerate all available shapes by calling list_shapes.

Returns:

  • (String) 


154
155
156
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 154

def shape
  @shape
end

#source_details ⇒ OCI::Core::Models::InstanceConfigurationInstanceSourceDetails

Details for creating an instance. Use this parameter to specify whether a boot volume or an image should be used to launch a new instance.

Returns:



160
161
162
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 160

def source_details
  @source_details
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 181

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'compartment_id': :'compartmentId',
    'create_vnic_details': :'createVnicDetails',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'extended_metadata': :'extendedMetadata',
    'freeform_tags': :'freeformTags',
    'ipxe_script': :'ipxeScript',
    'metadata': :'metadata',
    'shape': :'shape',
    'source_details': :'sourceDetails',
    'fault_domain': :'faultDomain'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 201

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'compartment_id': :'String',
    'create_vnic_details': :'OCI::Core::Models::InstanceConfigurationCreateVnicDetails',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'extended_metadata': :'Hash<String, Object>',
    'freeform_tags': :'Hash<String, String>',
    'ipxe_script': :'String',
    'metadata': :'Hash<String, String>',
    'shape': :'String',
    'source_details': :'OCI::Core::Models::InstanceConfigurationInstanceSourceDetails',
    'fault_domain': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 316

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    compartment_id == other.compartment_id &&
    create_vnic_details == other.create_vnic_details &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    extended_metadata == other.extended_metadata &&
    freeform_tags == other.freeform_tags &&
    ipxe_script == other.ipxe_script &&
    metadata == other.metadata &&
    shape == other.shape &&
    source_details == other.source_details &&
    fault_domain == other.fault_domain
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 357

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


337
338
339
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 337

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



346
347
348
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 346

def hash
  [availability_domain, compartment_id, create_vnic_details, defined_tags, display_name, extended_metadata, freeform_tags, ipxe_script, metadata, shape, source_details, fault_domain].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



390
391
392
393
394
395
396
397
398
399
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 390

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



384
385
386
 
# File 'lib/oci/core/models/instance_configuration_launch_instance_details.rb', line 384

def to_s
  to_hash.to_s
end