Class: MintPress::Aws::Lightsail::InstancesFromSnapshot

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instances_from_snapshot.rb

Properties (Read/Write)

  • #instance_names ⇒ Array of ⇒ [String]
    'The names for your new instances.'
    Property Attributes
    • create_instances_from_snapshot_prop ⇒ 'instance_names'
    • read_only ⇒ false
    • source ⇒ "create_instances_from_snapshot"
    

20
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instances_from_snapshot.rb', line 20

property :instance_names, create_instances_from_snapshot_prop: 'instance_names', type: [String], array: true, read_only: false, source: "create_instances_from_snapshot", description: 'The names for your new instances.'
  • #attached_disk_mapping ⇒ []
    'An object containing information about one or more disk mappings.'
    Property Attributes
    • create_instances_from_snapshot_prop ⇒ 'attached_disk_mapping'
    • read_only ⇒ false
    • source ⇒ "create_instances_from_snapshot"
    

21
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instances_from_snapshot.rb', line 21

property :attached_disk_mapping, create_instances_from_snapshot_prop: 'attached_disk_mapping', type: [], read_only: false, source: "create_instances_from_snapshot", description: 'An object containing information about one or more disk mappings.'
  • #availability_zone ⇒ [String]
    'The Availability Zone where you want to create your instances. Use the following formatting: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.'
    Property Attributes
    • create_instances_from_snapshot_prop ⇒ 'availability_zone'
    • read_only ⇒ false
    • source ⇒ "create_instances_from_snapshot"
    

22
23
24
25
26
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instances_from_snapshot.rb', line 22

property :availability_zone, create_instances_from_snapshot_prop: 'availability_zone', type: [String], read_only: false, source: "create_instances_from_snapshot", description: 'The Availability Zone where you want to create your instances. Use the
following formatting: us-east-2a (case sensitive). You can get a
list of Availability Zones by using the get regions operation. Be
sure to add the include Availability Zones parameter to your
request.'
  • #instance_snapshot_name ⇒ [String]
    'The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots. Constraint: This parameter cannot be defined together with the source instance name parameter. The instance snapshot name and source instance name parameters are mutually exclusive. ^'
    Property Attributes
    • create_instances_from_snapshot_prop ⇒ 'instance_snapshot_name'
    • read_only ⇒ false
    • source ⇒ "create_instances_from_snapshot"
    

27
28
29
30
31
32
33
34
35
36
37
38
39
40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instances_from_snapshot.rb', line 27

property :instance_snapshot_name, create_instances_from_snapshot_prop: 'instance_snapshot_name', type: [String], read_only: false, source: "create_instances_from_snapshot", description: 'The name of the instance snapshot on which you are basing your new
instances. Use the get instance snapshots operation to return
information about your existing snapshots.

Constraint:


This parameter cannot be defined together with the source instance
name parameter. The instance snapshot name and source instance
name parameters are mutually exclusive.



^'
  • #user_data ⇒ [String]
    'You can create a launch script that configures a server with additional user data. For example, apt-get -y update. Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Dev Guide.'
    Property Attributes
    • create_instances_from_snapshot_prop ⇒ 'user_data'
    • read_only ⇒ false
    • source ⇒ "create_instances_from_snapshot"
    

41
42
43
44
45
46
47
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instances_from_snapshot.rb', line 41

property :user_data, create_instances_from_snapshot_prop: 'user_data', type: [String], read_only: false, source: "create_instances_from_snapshot", description: 'You can create a launch script that configures a server with
additional user data. For example, apt-get -y update.

 Depending on the machine image you choose, the command to get software
on your instance varies. Amazon Linux and CentOS use yum, Debian and
Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see
the Dev Guide.'
  • #key_pair_name ⇒ [String]
    'The name for your key pair.'
    Property Attributes
    • create_instances_from_snapshot_prop ⇒ 'key_pair_name'
    • read_only ⇒ false
    • source ⇒ "create_instances_from_snapshot"
    

48
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instances_from_snapshot.rb', line 48

property :key_pair_name, create_instances_from_snapshot_prop: 'key_pair_name', type: [String], read_only: false, source: "create_instances_from_snapshot", description: 'The name for your key pair.'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::Lightsail::Tag]
    'The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it"s created.'
    Property Attributes
    • create_instances_from_snapshot_prop ⇒ 'tags'
    • read_only ⇒ false
    • source ⇒ "create_instances_from_snapshot"
    

49
50
51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instances_from_snapshot.rb', line 49

property :tags, create_instances_from_snapshot_prop: 'tags', type: [MintPress::Aws::Lightsail::Tag], array: false, read_only: false, source: "create_instances_from_snapshot", description: 'The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it"s created.', hash: true
  • #add_ons ⇒ Hash of ⇒ [MintPress::Aws::Lightsail::AddOn]
    'An array of objects representing the add-ons to enable for the new instance.'
    Property Attributes
    • create_instances_from_snapshot_prop ⇒ 'add_ons'
    • read_only ⇒ false
    • source ⇒ "create_instances_from_snapshot"
    

52
53
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instances_from_snapshot.rb', line 52

property :add_ons, create_instances_from_snapshot_prop: 'add_ons', type: [MintPress::Aws::Lightsail::AddOn], array: false, read_only: false, source: "create_instances_from_snapshot", description: 'An array of objects representing the add-ons to enable for the new
instance.', hash: true
  • #source_instance_name ⇒ [String]
    'The name of the source instance from which the source automatic snapshot was created. Constraints: This parameter cannot be defined together with the instance snapshot name parameter. The source instance name and instance snapshot name parameters are mutually exclusive. Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.'
    Property Attributes
    • create_instances_from_snapshot_prop ⇒ 'source_instance_name'
    • read_only ⇒ false
    • source ⇒ "create_instances_from_snapshot"
    

54
55
56
57
58
59
60
61
62
63
64
65
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instances_from_snapshot.rb', line 54

property :source_instance_name, create_instances_from_snapshot_prop: 'source_instance_name', type: [String], read_only: false, source: "create_instances_from_snapshot", description: 'The name of the source instance from which the source automatic
snapshot was created.

Constraints:


This parameter cannot be defined together with the instance
snapshot name parameter. The source instance name and instance
snapshot name parameters are mutually exclusive.
Define this parameter only when creating a new instance from an
automatic snapshot. For more information, see the Lightsail Dev
Guide.'
  • #restore_date ⇒ [String]
    'The date of the automatic snapshot to use for the new instance. Use the get auto snapshots operation to identify the dates of the available automatic snapshots. Constraints: Must be specified in YYYY-MM-DD format. This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive. Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.'
    Property Attributes
    • create_instances_from_snapshot_prop ⇒ 'restore_date'
    • read_only ⇒ false
    • source ⇒ "create_instances_from_snapshot"
    

66
67
68
69
70
71
72
73
74
75
76
77
78
79
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instances_from_snapshot.rb', line 66

property :restore_date, create_instances_from_snapshot_prop: 'restore_date', type: [String], read_only: false, source: "create_instances_from_snapshot", description: 'The date of the automatic snapshot to use for the new instance. Use
the get auto snapshots operation to identify the dates of the
available automatic snapshots.

Constraints:


Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest
restorable auto snapshot parameter. The restore date and use
latest restorable auto snapshot parameters are mutually exclusive.
Define this parameter only when creating a new instance from an
automatic snapshot. For more information, see the Lightsail Dev
Guide.'
  • #use_latest_restorable_auto_snapshot ⇒ [TrueClass,FalseClass]
    'A Boolean value to indicate whether to use the latest available automatic snapshot. Constraints: This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive. Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.'
    Property Attributes
    • create_instances_from_snapshot_prop ⇒ 'use_latest_restorable_auto_snapshot'
    • read_only ⇒ false
    • source ⇒ "create_instances_from_snapshot"
    

80
81
82
83
84
85
86
87
88
89
90
91
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instances_from_snapshot.rb', line 80

property :use_latest_restorable_auto_snapshot, create_instances_from_snapshot_prop: 'use_latest_restorable_auto_snapshot', type: [TrueClass,FalseClass], read_only: false, source: "create_instances_from_snapshot", description: 'A Boolean value to indicate whether to use the latest available
automatic snapshot.

Constraints:


This parameter cannot be defined together with the restore date
parameter. The use latest restorable auto snapshot and restore
date parameters are mutually exclusive.
Define this parameter only when creating a new instance from an
automatic snapshot. For more information, see the Lightsail Dev
Guide.'
  • #bundle ⇒ [MintPress::Aws::Lightsail::Bundle]
    'The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).'
    Property Attributes
    • create_instances_from_snapshot_prop ⇒ 'bundle_id'
    • read_only ⇒ false
    • source ⇒ "create_instances_from_snapshot"
    • from ⇒ String
    

92
93
94
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instances_from_snapshot.rb', line 92

property :bundle, create_instances_from_snapshot_prop: 'bundle_id', type: [MintPress::Aws::Lightsail::Bundle], read_only: false, source: "create_instances_from_snapshot", description: 'The bundle of specification information for your virtual private
server (or instance), including the pricing plan (e.g.,
micro_1_0).', from: String
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

98
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instances_from_snapshot.rb', line 98

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

101
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instances_from_snapshot.rb', line 101

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ InstancesFromSnapshot

Returns a new instance of InstancesFromSnapshot.

Instance Method Details

#create ⇒ Object