Class: MintPress::Aws::Lightsail::Disk

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

Properties (Read/Write)

  • #disk_name ⇒ [String]
    'The name of the disk (e.g., my-disk).'
    Property Attributes
    • attach_disk_prop ⇒ 'disk_name'
    • read_only ⇒ false
    • source ⇒ "get_disk"
    • create_disk_prop ⇒ 'disk_name'
    • delete_disk_prop ⇒ 'disk_name'
    • detach_disk_prop ⇒ 'disk_name'
    • get_disk_prop ⇒ 'disk_name'
    

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

property :disk_name, attach_disk_prop: 'disk_name', type: [String], read_only: false, source: "get_disk", description: 'The name of the disk (e.g., my-disk).', create_disk_prop: 'disk_name', delete_disk_prop: 'disk_name', detach_disk_prop: 'disk_name', get_disk_prop: 'disk_name'
  • #instance_name ⇒ [String]
    'The name of the Lightsail instance where you want to utilize the storage disk.'
    Property Attributes
    • attach_disk_prop ⇒ 'instance_name'
    • read_only ⇒ false
    • source ⇒ "attach_disk"
    

29
30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/disk.rb', line 29

property :instance_name, attach_disk_prop: 'instance_name', type: [String], read_only: false, source: "attach_disk", description: 'The name of the Lightsail instance where you want to utilize the
storage disk.'
  • #disk_path ⇒ [String]
    'The disk path to expose to the instance (e.g., /dev/xvdf).'
    Property Attributes
    • attach_disk_prop ⇒ 'disk_path'
    • read_only ⇒ false
    • source ⇒ "attach_disk"
    

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

property :disk_path, attach_disk_prop: 'disk_path', type: [String], read_only: false, source: "attach_disk", description: 'The disk path to expose to the instance (e.g., /dev/xvdf).'
  • #availability_zone ⇒ [String]
    'The Availability Zone where you want to create the disk (e.g., us-east-2a). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk. Use the get regions operation to list the Availability Zones where Lightsail is currently available.'
    Property Attributes
    • create_disk_prop ⇒ 'availability_zone'
    • read_only ⇒ false
    • source ⇒ "create_disk"
    

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

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

Use the get regions operation to list the Availability Zones where
Lightsail is currently available.'
  • #size_in_gb ⇒ [Integer]
    'The size of the disk in GB.'
    Property Attributes
    • create_disk_prop ⇒ 'size_in_gb'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'size_in_gb'
    

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

property :size_in_gb, create_disk_prop: 'size_in_gb', type: [Integer], disposition: :attribute, read_only: false, source: "MintPress::Aws::Lightsail::Disk", description: 'The size of the disk in GB.', orig_name: 'size_in_gb'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::Lightsail::Tag]
    'The tag keys and optional values for the resource.'
    Property Attributes
    • create_disk_prop ⇒ 'tags'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'tags'
    

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

property :tags, create_disk_prop: 'tags', type: [MintPress::Aws::Lightsail::Tag], array: false, disposition: :attribute, read_only: false, source: "MintPress::Aws::Lightsail::Disk", description: 'The tag keys and optional values for the resource.', orig_name: 'tags', hash: true
  • #add_ons ⇒ Hash of ⇒ [MintPress::Aws::Lightsail::AddOn]
    'An array of objects representing the add-ons enabled on the disk.'
    Property Attributes
    • create_disk_prop ⇒ 'add_ons'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'add_ons'
    

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

property :add_ons, create_disk_prop: 'add_ons', type: [MintPress::Aws::Lightsail::AddOn], array: false, disposition: :attribute, read_only: false, source: "MintPress::Aws::Lightsail::Disk", description: 'An array of objects representing the add-ons enabled on the disk.', orig_name: 'add_ons', hash: true
  • #force_delete_add_ons ⇒ [TrueClass,FalseClass]
    'A Boolean value to indicate whether to delete the enabled add-ons for the disk.'
    Property Attributes
    • delete_disk_prop ⇒ 'force_delete_add_ons'
    • read_only ⇒ false
    • source ⇒ "delete_disk"
    

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

property :force_delete_add_ons, delete_disk_prop: 'force_delete_add_ons', type: [TrueClass,FalseClass], read_only: false, source: "delete_disk", description: 'A Boolean value to indicate whether to delete the enabled add-ons for
the disk.'
  • #arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the disk.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'arn'
    

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

property :arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the disk.', source: "MintPress::Aws::Lightsail::Disk", orig_name: 'arn', type: [String]
  • #attached_to ⇒ [String]
    'The resources to which the disk is attached.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'attached_to'
    

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

property :attached_to, disposition: :attribute, description: 'The resources to which the disk is attached.', source: "MintPress::Aws::Lightsail::Disk", orig_name: 'attached_to', type: [String]
  • #attachment_state ⇒ [String]
    '(Deprecated) The attachment state of the disk.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'attachment_state'
    

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

property :attachment_state, disposition: :attribute, description: '(Deprecated) The attachment state of the disk.', source: "MintPress::Aws::Lightsail::Disk", orig_name: 'attachment_state', type: [String]
  • #created_at ⇒ [Time]
    'The date when the disk was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'created_at'
    

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

property :created_at, disposition: :attribute, description: 'The date when the disk was created.', source: "MintPress::Aws::Lightsail::Disk", orig_name: 'created_at', type: [Time]
  • #gb_in_use ⇒ [Integer]
    '(Deprecated) The number of GB in use by the disk.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'gb_in_use'
    

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

property :gb_in_use, disposition: :attribute, description: '(Deprecated) The number of GB in use by the disk.', source: "MintPress::Aws::Lightsail::Disk", orig_name: 'gb_in_use', type: [Integer]
  • #iops ⇒ [Integer]
    'The input/output operations per second (IOPS) of the disk.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'iops'
    

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

property :iops, disposition: :attribute, description: 'The input/output operations per second (IOPS) of the disk.', source: "MintPress::Aws::Lightsail::Disk", orig_name: 'iops', type: [Integer]
  • #is_attached ⇒ [TrueClass,FalseClass]
    'A Boolean value indicating whether the disk is attached.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'is_attached'
    

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

property :is_attached, disposition: :attribute, description: 'A Boolean value indicating whether the disk is attached.', source: "MintPress::Aws::Lightsail::Disk", orig_name: 'is_attached', type: [TrueClass,FalseClass]
  • #is_system_disk ⇒ [TrueClass,FalseClass]
    'A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'is_system_disk'
    

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

property :is_system_disk, disposition: :attribute, description: 'A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).', source: "MintPress::Aws::Lightsail::Disk", orig_name: 'is_system_disk', type: [TrueClass,FalseClass]
  • #location ⇒ [MintPress::Aws::Lightsail::ResourceLocation] (Default Value: MintPress::Aws::Lightsail::ResourceLocation.new)
    'The AWS Region and Availability Zone where the disk is located.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'location'
    • default ⇒ MintPress::Aws::Lightsail::ResourceLocation.new
    

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

property :location, disposition: :attribute, description: 'The AWS Region and Availability Zone where the disk is located.', source: "MintPress::Aws::Lightsail::Disk", orig_name: 'location', type: [MintPress::Aws::Lightsail::ResourceLocation], default: MintPress::Aws::Lightsail::ResourceLocation.new
  • #name ⇒ [String]
    'The unique name of the disk.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'name'
    

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

property :name, disposition: :attribute, description: 'The unique name of the disk.', source: "MintPress::Aws::Lightsail::Disk", orig_name: 'name', type: [String]
  • #path ⇒ [String]
    'The disk path.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'path'
    

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

property :path, disposition: :attribute, description: 'The disk path.', source: "MintPress::Aws::Lightsail::Disk", orig_name: 'path', type: [String]
  • #resource_type ⇒ [String]
    'The Lightsail resource type (e.g., Disk).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'resource_type'
    

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

property :resource_type, disposition: :attribute, description: 'The Lightsail resource type (e.g., Disk).', source: "MintPress::Aws::Lightsail::Disk", orig_name: 'resource_type', type: [String]
  • #state ⇒ [String]
    'Describes the status of the disk.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'state'
    

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

property :state, disposition: :attribute, description: 'Describes the status of the disk.', source: "MintPress::Aws::Lightsail::Disk", orig_name: 'state', type: [String]
  • #support_code ⇒ [String]
    'The support code.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Disk"
    • orig_name ⇒ 'support_code'
    

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

property :support_code, disposition: :attribute, description: 'The support code.', source: "MintPress::Aws::Lightsail::Disk", orig_name: 'support_code', type: [String]
  • #page_token ⇒ [String]
    'The token to advance to the next page of results from your request. To get a page token, perform an initial GetDisks request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.'
    Property Attributes
    • get_disks_prop ⇒ 'page_token'
    • read_only ⇒ false
    • source ⇒ "get_disks"
    

57
58
59
60
61
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/disk.rb', line 57

property :page_token, get_disks_prop: 'page_token', type: [String], read_only: false, source: "get_disks", description: 'The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDisks request. If your
results are paginated, the response will return a next page token that
you can specify as the page token in a subsequent request.'
  • #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 
    

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

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
    

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

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

Returns a new instance of Disk.

Instance Method Details

#attach ⇒ Object

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#detach ⇒ Object

#get ⇒ Object