Class: Aws::EC2::Volume

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, options = {}) ⇒ Volume #initialize(options = {}) ⇒ Volume

Returns a new instance of Volume.

Overloads:

  • #initialize(id, options = {}) ⇒ Volume

    Parameters:

    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Volume

    Options Hash (options):

    • :id (required, String)
    • :client (Client) 


22
23
24
25
26
27
28
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @id = extract_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#attach_to_instance(options = {}) ⇒ Types::VolumeAttachment

Examples:

Request syntax with placeholder values


volume.attach_to_instance({
  device: "String", # required
  instance_id: "InstanceId", # required
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :device (required, String) —

    The device name (for example, /dev/sdh or xvdh).

  • :instance_id (required, String) —

    The ID of the instance.

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:



295
296
297
298
299
300
301
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 295

def attach_to_instance(options = {})
  options = options.merge(volume_id: @id)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.attach_volume(options)
  end
  resp.data
end

#attachments ⇒ Array<Types::VolumeAttachment>

Information about the volume attachments.

Returns:



40
41
42
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 40

def attachments
  data[:attachments]
end

#availability_zone ⇒ String

The Availability Zone for the volume.

Returns:

  • (String) 


46
47
48
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 46

def availability_zone
  data[:availability_zone]
end

#client ⇒ Client

Returns:



142
143
144
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 142

def client
  @client
end

#create_snapshot(options = {}) ⇒ Snapshot

Examples:

Request syntax with placeholder values


snapshot = volume.create_snapshot({
  description: "String",
  outpost_arn: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-gateway, coip-pool, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, instance-event-window, internet-gateway, ipam, ipam-pool, ipam-scope, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, network-insights-access-scope, network-insights-access-scope-analysis, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, snapshot, spot-fleet-request, spot-instances-request, subnet, subnet-cidr-reservation, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-policy-table, transit-gateway-route-table, transit-gateway-route-table-announcement, volume, vpc, vpc-endpoint, vpc-endpoint-connection, vpc-endpoint-service, vpc-endpoint-service-permission, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log, capacity-reservation-fleet, traffic-mirror-filter-rule, vpc-endpoint-connection-device-type, verified-access-instance, verified-access-group, verified-access-endpoint, verified-access-policy, verified-access-trust-provider, vpn-connection-device-type, vpc-block-public-access-exclusion, ipam-resource-discovery, ipam-resource-discovery-association, instance-connect-endpoint
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :description (String) —

    A description for the snapshot.

  • :outpost_arn (String) —

    The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.

    • To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

    • To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

    • To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

    For more information, see Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the snapshot during creation.

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:



353
354
355
356
357
358
359
360
361
362
363
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 353

def create_snapshot(options = {})
  options = options.merge(volume_id: @id)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.create_snapshot(options)
  end
  Snapshot.new(
    id: resp.data.snapshot_id,
    data: resp.data,
    client: @client
  )
end

#create_tags(options = {}) ⇒ Tag::Collection

Examples:

Request syntax with placeholder values


tag = volume.create_tags({
  dry_run: false,
  tags: [ # required
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • :tags (required, Array<Types::Tag>) —

    The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

Returns:



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 387

def create_tags(options = {})
  batch = []
  options = Aws::Util.deep_merge(options, resources: [@id])
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.create_tags(options)
  end
  options[:tags].each do |t|
    batch << Tag.new(
      resource_id: @id,
      key: t[:key],
      value: t[:value],
      client: @client
    )
  end
  Tag::Collection.new([batch], size: batch.size)
end

#create_time ⇒ Time

The time stamp when volume creation was initiated.

Returns:

  • (Time) 


52
53
54
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 52

def create_time
  data[:create_time]
end

#data ⇒ Types::Volume

Returns the data for this Aws::EC2::Volume. Calls Client#describe_volumes if #data_loaded? is false.

Returns:



164
165
166
167
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 164

def data
  load unless @data
  @data
end

#data_loaded? ⇒ Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean) —

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



172
173
174
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 172

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


volume.delete({
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (EmptyStructure) 


463
464
465
466
467
468
469
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 463

def delete(options = {})
  options = options.merge(volume_id: @id)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.delete_volume(options)
  end
  resp.data
end

#delete_tags(options = {}) ⇒ Tag::Collection

Examples:

Request syntax with placeholder values


tag = volume.delete_tags({
  dry_run: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • :tags (Array<Types::Tag>) —

    The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.

    If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete Amazon Web Services-generated tags (tags that have the aws: prefix).

    Constraints: Up to 1000 tags.

Returns:



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 434

def delete_tags(options = {})
  batch = []
  options = Aws::Util.deep_merge(options, resources: [@id])
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.delete_tags(options)
  end
  options[:tags].each do |t|
    batch << Tag.new(
      resource_id: @id,
      key: t[:key],
      value: t[:value],
      client: @client
    )
  end
  Tag::Collection.new([batch], size: batch.size)
end

#describe_attribute(options = {}) ⇒ Types::DescribeVolumeAttributeResult

Examples:

Request syntax with placeholder values


volume.describe_attribute({
  attribute: "autoEnableIO", # required, accepts autoEnableIO, productCodes
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :attribute (required, String) —

    The attribute of the volume. This parameter is required.

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:



486
487
488
489
490
491
492
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 486

def describe_attribute(options = {})
  options = options.merge(volume_id: @id)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.describe_volume_attribute(options)
  end
  resp.data
end

#describe_status(options = {}) ⇒ Types::DescribeVolumeStatusResult

Examples:

Request syntax with placeholder values


volume.describe_status({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :filters (Array<Types::Filter>) —

    The filters.

    • action.code - The action code for the event (for example, enable-volume-io).

    • action.description - A description of the action.

    • action.event-id - The event ID associated with the action.

    • availability-zone - The Availability Zone of the instance.

    • event.description - A description of the event.

    • event.event-id - The event ID.

    • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

    • event.not-after - The latest end time for the event.

    • event.not-before - The earliest start time for the event.

    • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

    • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

    • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1,000; if the value is larger than 1,000, only 1,000 results are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:



563
564
565
566
567
568
569
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 563

def describe_status(options = {})
  options = Aws::Util.deep_merge(options, volume_ids: [@id])
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.describe_volume_status(options)
  end
  resp.data
end

#detach_from_instance(options = {}) ⇒ Types::VolumeAttachment

Examples:

Request syntax with placeholder values


volume.detach_from_instance({
  device: "String",
  force: false,
  instance_id: "InstanceIdForResolver",
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :device (String) —

    The device name.

  • :force (Boolean) —

    Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

  • :instance_id (String) —

    The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:



600
601
602
603
604
605
606
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 600

def detach_from_instance(options = {})
  options = options.merge(volume_id: @id)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.detach_volume(options)
  end
  resp.data
end

#enable_io(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


volume.enable_io({
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (EmptyStructure) 


620
621
622
623
624
625
626
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 620

def enable_io(options = {})
  options = options.merge(volume_id: @id)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.enable_volume_io(options)
  end
  resp.data
end

#encrypted ⇒ Boolean

Indicates whether the volume is encrypted.

Returns:

  • (Boolean) 


58
59
60
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 58

def encrypted
  data[:encrypted]
end

#fast_restored ⇒ Boolean

Indicates whether the volume was created using fast snapshot restore.

Returns:

  • (Boolean) 


117
118
119
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 117

def fast_restored
  data[:fast_restored]
end

#id ⇒ String Also known as: volume_id

Returns:

  • (String) 


33
34
35
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 33

def id
  @id
end

#iops ⇒ Integer

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

Returns:

  • (Integer) 


99
100
101
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 99

def iops
  data[:iops]
end

#kms_key_id ⇒ String

The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.

Returns:

  • (String) 


65
66
67
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 65

def kms_key_id
  data[:kms_key_id]
end

#load ⇒ self Also known as: reload

Loads, or reloads #data for the current Aws::EC2::Volume. Returns self making it possible to chain methods.

volume.reload.data

Returns:

  • (self) 


152
153
154
155
156
157
158
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 152

def load
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.describe_volumes(volume_ids: [@id])
  end
  @data = resp.volumes[0]
  self
end

#modify_attribute(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


volume.modify_attribute({
  auto_enable_io: {
    value: false,
  },
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :auto_enable_io (Types::AttributeBooleanValue) —

    Indicates whether the volume should be auto-enabled for I/O operations.

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (EmptyStructure) 


646
647
648
649
650
651
652
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 646

def modify_attribute(options = {})
  options = options.merge(volume_id: @id)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.modify_volume_attribute(options)
  end
  resp.data
end

#multi_attach_enabled ⇒ Boolean

Indicates whether Amazon EBS Multi-Attach is enabled.

Returns:

  • (Boolean) 


123
124
125
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 123

def multi_attach_enabled
  data[:multi_attach_enabled]
end

#outpost_arn ⇒ String

The Amazon Resource Name (ARN) of the Outpost.

Returns:

  • (String) 


71
72
73
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 71

def outpost_arn
  data[:outpost_arn]
end

#size ⇒ Integer

The size of the volume, in GiBs.

Returns:

  • (Integer) 


77
78
79
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 77

def size
  data[:size]
end

#snapshot_id ⇒ String

The snapshot from which the volume was created, if applicable.

Returns:

  • (String) 


83
84
85
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 83

def snapshot_id
  data[:snapshot_id]
end

#snapshots(options = {}) ⇒ Snapshot::Collection

Examples:

Request syntax with placeholder values


snapshots = volume.snapshots({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  owner_ids: ["String"],
  restorable_by_user_ids: ["String"],
  snapshot_ids: ["SnapshotId"],
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :filters (Array<Types::Filter>) —

    The filters.

    • description - A description of the snapshot.

    • encrypted - Indicates whether the snapshot is encrypted (true | false)

    • owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

    • owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter.

    • progress - The progress of the snapshot, as a percentage (for example, 80%).

    • snapshot-id - The snapshot ID.

    • start-time - The time stamp when the snapshot was initiated.

    • status - The status of the snapshot (pending | completed | error).

    • storage-tier - The storage tier of the snapshot (archive | standard).

    • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    • volume-id - The ID of the volume the snapshot is for.

    • volume-size - The size of the volume, in GiB.

  • :owner_ids (Array<String>) —

    Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.

  • :restorable_by_user_ids (Array<String>) —

    The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.

  • :snapshot_ids (Array<String>) —

    The snapshot IDs.

    Default: Describes the snapshots for which you have create volume permissions.

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:



731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 731

def snapshots(options = {})
  batches = Enumerator.new do |y|
    options = Aws::Util.deep_merge(options, filters: [{
      name: "volume-id",
      values: [@id]
    }])
    resp = Aws::Plugins::UserAgent.feature('resource') do
      @client.describe_snapshots(options)
    end
    resp.each_page do |page|
      batch = []
      page.data.snapshots.each do |s|
        batch << Snapshot.new(
          id: s.snapshot_id,
          data: s,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Snapshot::Collection.new(batches)
end

#sse_type ⇒ String

Reserved for future use.

Returns:

  • (String) 


135
136
137
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 135

def sse_type
  data[:sse_type]
end

#state ⇒ String

The volume state.

Returns:

  • (String) 


89
90
91
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 89

def state
  data[:state]
end

#tags ⇒ Array<Types::Tag>

Any tags assigned to the volume.

Returns:



105
106
107
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 105

def tags
  data[:tags]
end

#throughput ⇒ Integer

The throughput that the volume supports, in MiB/s.

Returns:

  • (Integer) 


129
130
131
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 129

def throughput
  data[:throughput]
end

#volume_type ⇒ String

The volume type.

Returns:

  • (String) 


111
112
113
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 111

def volume_type
  data[:volume_type]
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::EC2::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged.

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) do |instance|
  instance.state.name == 'running'
end

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10 —

    Maximum number of

  • :delay (Integer) — default: 10 —

    Delay between each

  • :before_attempt (Proc) — default: nil —

    Callback

  • :before_wait (Proc) — default: nil —

    Callback

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

Returns:

  • (Resource) —

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError) —

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError) —

    Raised when the resource does not



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 256

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Plugins::UserAgent.feature('resource') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end