Class: MintPress::Aws::Lightsail::DiskSnapshot

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

Properties (Read/Write)

  • #disk_name ⇒ [String]
    'The unique name of the source disk (e.g., Disk-Virginia-1). This parameter cannot be defined together with the instance name parameter. The disk name and instance name parameters are mutually exclusive.'
    Property Attributes
    • create_disk_snapshot_prop ⇒ 'disk_name'
    • read_only ⇒ false
    • source ⇒ "create_disk_snapshot"
    

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

property :disk_name, create_disk_snapshot_prop: 'disk_name', type: [String], read_only: false, source: "create_disk_snapshot", description: 'The unique name of the source disk (e.g., Disk-Virginia-1).

 This parameter cannot be defined together with the instance name
parameter. The disk name and instance name parameters are mutually
exclusive.'
  • #disk_snapshot_name ⇒ [String]
    'The name of the disk snapshot (e.g., my-disk-snapshot).'
    Property Attributes
    • create_disk_snapshot_prop ⇒ 'disk_snapshot_name'
    • read_only ⇒ false
    • source ⇒ "get_disk_snapshot"
    • delete_disk_snapshot_prop ⇒ 'disk_snapshot_name'
    • get_disk_snapshot_prop ⇒ 'disk_snapshot_name'
    

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

property :disk_snapshot_name, create_disk_snapshot_prop: 'disk_snapshot_name', type: [String], read_only: false, source: "get_disk_snapshot", description: 'The name of the disk snapshot (e.g., my-disk-snapshot).', delete_disk_snapshot_prop: 'disk_snapshot_name', get_disk_snapshot_prop: 'disk_snapshot_name'
  • #instance_name ⇒ [String]
    'The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1). When this is defined, a snapshot of the instance"s system volume is created. This parameter cannot be defined together with the disk name parameter. The instance name and disk name parameters are mutually exclusive.'
    Property Attributes
    • create_disk_snapshot_prop ⇒ 'instance_name'
    • read_only ⇒ false
    • source ⇒ "create_disk_snapshot"
    

29
30
31
32
33
34
35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/disk_snapshot.rb', line 29

property :instance_name, create_disk_snapshot_prop: 'instance_name', type: [String], read_only: false, source: "create_disk_snapshot", description: 'The unique name of the source instance (e.g.,
Amazon_Linux-512MB-Virginia-1). When this is defined, a snapshot of
the instance"s system volume is created.

 This parameter cannot be defined together with the disk name
parameter. The instance name and disk name parameters are mutually
exclusive.'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::Lightsail::Tag]
    'The tag keys and optional values for the resource.'
    Property Attributes
    • create_disk_snapshot_prop ⇒ 'tags'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::Lightsail::DiskSnapshot"
    • orig_name ⇒ 'tags'
    

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

property :tags, create_disk_snapshot_prop: 'tags', type: [MintPress::Aws::Lightsail::Tag], array: false, disposition: :attribute, read_only: false, source: "MintPress::Aws::Lightsail::DiskSnapshot", description: 'The tag keys and optional values for the resource.', orig_name: 'tags', hash: true
  • #arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the disk snapshot.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::DiskSnapshot"
    • orig_name ⇒ 'arn'
    

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

property :arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the disk snapshot.', source: "MintPress::Aws::Lightsail::DiskSnapshot", orig_name: 'arn', type: [String]
  • #created_at ⇒ [Time]
    'The date when the disk snapshot was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::DiskSnapshot"
    • orig_name ⇒ 'created_at'
    

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

property :created_at, disposition: :attribute, description: 'The date when the disk snapshot was created.', source: "MintPress::Aws::Lightsail::DiskSnapshot", orig_name: 'created_at', type: [Time]
  • #from_disk_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::DiskSnapshot"
    • orig_name ⇒ 'from_disk_arn'
    

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

property :from_disk_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.', source: "MintPress::Aws::Lightsail::DiskSnapshot", orig_name: 'from_disk_arn', type: [String]
  • #from_disk_name ⇒ [String]
    'The unique name of the source disk from which the disk snapshot was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::DiskSnapshot"
    • orig_name ⇒ 'from_disk_name'
    

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

property :from_disk_name, disposition: :attribute, description: 'The unique name of the source disk from which the disk snapshot was created.', source: "MintPress::Aws::Lightsail::DiskSnapshot", orig_name: 'from_disk_name', type: [String]
  • #from_instance_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::DiskSnapshot"
    • orig_name ⇒ 'from_instance_arn'
    

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

property :from_instance_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.', source: "MintPress::Aws::Lightsail::DiskSnapshot", orig_name: 'from_instance_arn', type: [String]
  • #from_instance_name ⇒ [String]
    'The unique name of the source instance from which the disk (system volume) snapshot was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::DiskSnapshot"
    • orig_name ⇒ 'from_instance_name'
    

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

property :from_instance_name, disposition: :attribute, description: 'The unique name of the source instance from which the disk (system volume) snapshot was created.', source: "MintPress::Aws::Lightsail::DiskSnapshot", orig_name: 'from_instance_name', type: [String]
  • #is_from_auto_snapshot ⇒ [TrueClass,FalseClass]
    'A Boolean value indicating whether the snapshot was created from an automatic snapshot.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::DiskSnapshot"
    • orig_name ⇒ 'is_from_auto_snapshot'
    

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

property :is_from_auto_snapshot, disposition: :attribute, description: 'A Boolean value indicating whether the snapshot was created from an automatic snapshot.', source: "MintPress::Aws::Lightsail::DiskSnapshot", orig_name: 'is_from_auto_snapshot', type: [TrueClass,FalseClass]
  • #location ⇒ [MintPress::Aws::Lightsail::ResourceLocation] (Default Value: MintPress::Aws::Lightsail::ResourceLocation.new)
    'The AWS Region and Availability Zone where the disk snapshot was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::DiskSnapshot"
    • orig_name ⇒ 'location'
    • default ⇒ MintPress::Aws::Lightsail::ResourceLocation.new
    

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

property :location, disposition: :attribute, description: 'The AWS Region and Availability Zone where the disk snapshot was created.', source: "MintPress::Aws::Lightsail::DiskSnapshot", orig_name: 'location', type: [MintPress::Aws::Lightsail::ResourceLocation], default: MintPress::Aws::Lightsail::ResourceLocation.new
  • #name ⇒ [String]
    'The name of the disk snapshot (e.g., my-disk-snapshot).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::DiskSnapshot"
    • orig_name ⇒ 'name'
    

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

property :name, disposition: :attribute, description: 'The name of the disk snapshot (e.g., my-disk-snapshot).', source: "MintPress::Aws::Lightsail::DiskSnapshot", orig_name: 'name', type: [String]
  • #progress ⇒ [String]
    'The progress of the disk snapshot operation.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::DiskSnapshot"
    • orig_name ⇒ 'progress'
    

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

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

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

property :resource_type, disposition: :attribute, description: 'The Lightsail resource type (e.g., DiskSnapshot).', source: "MintPress::Aws::Lightsail::DiskSnapshot", orig_name: 'resource_type', type: [String]
  • #size_in_gb ⇒ [Integer]
    'The size of the disk in GB.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::DiskSnapshot"
    • orig_name ⇒ 'size_in_gb'
    

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

property :size_in_gb, disposition: :attribute, description: 'The size of the disk in GB.', source: "MintPress::Aws::Lightsail::DiskSnapshot", orig_name: 'size_in_gb', type: [Integer]
  • #state ⇒ [String]
    'The status of the disk snapshot operation.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::DiskSnapshot"
    • orig_name ⇒ 'state'
    

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

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

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

property :support_code, disposition: :attribute, description: 'The support code.', source: "MintPress::Aws::Lightsail::DiskSnapshot", 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 GetDiskSnapshots 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_disk_snapshots_prop ⇒ 'page_token'
    • read_only ⇒ false
    • source ⇒ "get_disk_snapshots"
    

51
52
53
54
55
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/disk_snapshot.rb', line 51

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

To get a page token, perform an initial GetDiskSnapshots 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 
    

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

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
    

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

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

Returns a new instance of DiskSnapshot.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#get ⇒ Object