Class: MintPress::Aws::Lightsail::DiskFromSnapshot

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

Properties (Read/Write)

  • #disk_name ⇒ [String]
    'The unique Lightsail disk name (e.g., my-disk).'
    Property Attributes
    • create_disk_from_snapshot_prop ⇒ 'disk_name'
    • read_only ⇒ false
    • source ⇒ "create_disk_from_snapshot"
    

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

property :disk_name, create_disk_from_snapshot_prop: 'disk_name', type: [String], read_only: false, source: "create_disk_from_snapshot", description: 'The unique Lightsail disk name (e.g., my-disk).'
  • #disk_snapshot_name ⇒ [String]
    'The name of the disk snapshot (e.g., my-snapshot) from which to create the new storage disk. Constraint: This parameter cannot be defined together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive. ^'
    Property Attributes
    • create_disk_from_snapshot_prop ⇒ 'disk_snapshot_name'
    • read_only ⇒ false
    • source ⇒ "create_disk_from_snapshot"
    

20
21
22
23
24
25
26
27
28
29
30
31
32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/disk_from_snapshot.rb', line 20

property :disk_snapshot_name, create_disk_from_snapshot_prop: 'disk_snapshot_name', type: [String], read_only: false, source: "create_disk_from_snapshot", description: 'The name of the disk snapshot (e.g., my-snapshot) from which to
create the new storage disk.

Constraint:


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



^'
  • #availability_zone ⇒ [String]
    'The Availability Zone where you want to create the disk (e.g., us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk. Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.'
    Property Attributes
    • create_disk_from_snapshot_prop ⇒ 'availability_zone'
    • read_only ⇒ false
    • source ⇒ "create_disk_from_snapshot"
    

33
34
35
36
37
38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/disk_from_snapshot.rb', line 33

property :availability_zone, create_disk_from_snapshot_prop: 'availability_zone', type: [String], read_only: false, source: "create_disk_from_snapshot", description: 'The Availability Zone where you want to create the disk (e.g.,
us-east-2a). Choose the same Availability Zone as the Lightsail
instance where you want to create the disk.

Use the GetRegions operation to list the Availability Zones where
Lightsail is currently available.'
  • #size_in_gb ⇒ [Integer]
    'The size of the disk in GB (e.g., 32).'
    Property Attributes
    • create_disk_from_snapshot_prop ⇒ 'size_in_gb'
    • read_only ⇒ false
    • source ⇒ "create_disk_from_snapshot"
    

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

property :size_in_gb, create_disk_from_snapshot_prop: 'size_in_gb', type: [Integer], read_only: false, source: "create_disk_from_snapshot", description: 'The size of the disk in GB (e.g., 32).'
  • #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_disk_from_snapshot_prop ⇒ 'tags'
    • read_only ⇒ false
    • source ⇒ "create_disk_from_snapshot"
    

40
41
42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/disk_from_snapshot.rb', line 40

property :tags, create_disk_from_snapshot_prop: 'tags', type: [MintPress::Aws::Lightsail::Tag], array: false, read_only: false, source: "create_disk_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 that represent the add-ons to enable for the new disk.'
    Property Attributes
    • create_disk_from_snapshot_prop ⇒ 'add_ons'
    • read_only ⇒ false
    • source ⇒ "create_disk_from_snapshot"
    

43
44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/disk_from_snapshot.rb', line 43

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

45
46
47
48
49
50
51
52
53
54
55
56
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/disk_from_snapshot.rb', line 45

property :source_disk_name, create_disk_from_snapshot_prop: 'source_disk_name', type: [String], read_only: false, source: "create_disk_from_snapshot", description: 'The name of the source disk from which the source automatic snapshot
was created.

Constraints:


This parameter cannot be defined together with the disk snapshot
name parameter. The source disk name and disk snapshot name
parameters are mutually exclusive.
Define this parameter only when creating a new disk 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 disk. 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 disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.'
    Property Attributes
    • create_disk_from_snapshot_prop ⇒ 'restore_date'
    • read_only ⇒ false
    • source ⇒ "create_disk_from_snapshot"
    

57
58
59
60
61
62
63
64
65
66
67
68
69
70
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/disk_from_snapshot.rb', line 57

property :restore_date, create_disk_from_snapshot_prop: 'restore_date', type: [String], read_only: false, source: "create_disk_from_snapshot", description: 'The date of the automatic snapshot to use for the new disk. 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 disk 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 disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.'
    Property Attributes
    • create_disk_from_snapshot_prop ⇒ 'use_latest_restorable_auto_snapshot'
    • read_only ⇒ false
    • source ⇒ "create_disk_from_snapshot"
    

71
72
73
74
75
76
77
78
79
80
81
82
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/disk_from_snapshot.rb', line 71

property :use_latest_restorable_auto_snapshot, create_disk_from_snapshot_prop: 'use_latest_restorable_auto_snapshot', type: [TrueClass,FalseClass], read_only: false, source: "create_disk_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 disk from an
automatic snapshot. For more information, see the Lightsail Dev
Guide.'
  • #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 
    

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

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
    

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

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 = {}) ⇒ DiskFromSnapshot

Returns a new instance of DiskFromSnapshot.

Instance Method Details

#create ⇒ Object