Class: Aws::EC2::Instance::Collection

Inherits:
Resources::Collection show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb

Batch Actions collapse

Methods inherited from Resources::Collection

#each, #first, #limit, #size

Instance Method Details

#batch_create_tags(options = {}) ⇒ void

This method returns an undefined value.

Examples:

Request syntax with placeholder values


instance.batch_create_tags({
  dry_run: false,
  tags: [ # required
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

  • options ({}) (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.



1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1622

def batch_create_tags(options = {})
  batch_enum.each do |batch|
    params = Aws::Util.copy_hash(options)
    params[:resources] ||= []
    batch.each do |item|
      params[:resources] << item.id
    end
    batch[0].client.create_tags(params)
  end
  nil
end

#batch_delete_tags!(options = {}) ⇒ void

This method returns an undefined value.

Examples:

Request syntax with placeholder values


instance.batch_delete_tags!({
  dry_run: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

  • options ({}) (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 AWS-generated tags (tags that have the aws: prefix).



1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1662

def batch_delete_tags!(options = {})
  batch_enum.each do |batch|
    params = Aws::Util.copy_hash(options)
    params[:resources] ||= []
    batch.each do |item|
      params[:resources] << item.id
    end
    batch[0].client.delete_tags(params)
  end
  nil
end

#batch_monitor(options = {}) ⇒ void

This method returns an undefined value.

Examples:

Request syntax with placeholder values


instance.batch_monitor({
  dry_run: false,
})

Parameters:

  • options ({}) (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.



1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1686

def batch_monitor(options = {})
  batch_enum.each do |batch|
    params = Aws::Util.copy_hash(options)
    params[:instance_ids] ||= []
    batch.each do |item|
      params[:instance_ids] << item.id
    end
    batch[0].client.monitor_instances(params)
  end
  nil
end

#batch_reboot(options = {}) ⇒ void

This method returns an undefined value.

Examples:

Request syntax with placeholder values


instance.batch_reboot({
  dry_run: false,
})

Parameters:

  • options ({}) (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.



1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1710

def batch_reboot(options = {})
  batch_enum.each do |batch|
    params = Aws::Util.copy_hash(options)
    params[:instance_ids] ||= []
    batch.each do |item|
      params[:instance_ids] << item.id
    end
    batch[0].client.reboot_instances(params)
  end
  nil
end

#batch_start(options = {}) ⇒ void

This method returns an undefined value.

Examples:

Request syntax with placeholder values


instance.batch_start({
  additional_info: "String",
  dry_run: false,
})

Parameters:

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

Options Hash (options):

  • :additional_info (String)

    Reserved.

  • :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.



1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1737

def batch_start(options = {})
  batch_enum.each do |batch|
    params = Aws::Util.copy_hash(options)
    params[:instance_ids] ||= []
    batch.each do |item|
      params[:instance_ids] << item.id
    end
    batch[0].client.start_instances(params)
  end
  nil
end

#batch_stop(options = {}) ⇒ void

This method returns an undefined value.

Examples:

Request syntax with placeholder values


instance.batch_stop({
  hibernate: false,
  dry_run: false,
  force: false,
})

Parameters:

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

Options Hash (options):

  • :hibernate (Boolean)

    Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.

    Default: false

  • :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.

  • :force (Boolean)

    Forces the instances to stop. The instances do not 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. This option is not recommended for Windows instances.

    Default: false



1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1781

def batch_stop(options = {})
  batch_enum.each do |batch|
    params = Aws::Util.copy_hash(options)
    params[:instance_ids] ||= []
    batch.each do |item|
      params[:instance_ids] << item.id
    end
    batch[0].client.stop_instances(params)
  end
  nil
end

#batch_terminate!(options = {}) ⇒ void

This method returns an undefined value.

Examples:

Request syntax with placeholder values


instance.batch_terminate!({
  dry_run: false,
})

Parameters:

  • options ({}) (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.



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1805

def batch_terminate!(options = {})
  batch_enum.each do |batch|
    params = Aws::Util.copy_hash(options)
    params[:instance_ids] ||= []
    batch.each do |item|
      params[:instance_ids] << item.id
    end
    batch[0].client.terminate_instances(params)
  end
  nil
end

#batch_unmonitor(options = {}) ⇒ void

This method returns an undefined value.

Examples:

Request syntax with placeholder values


instance.batch_unmonitor({
  dry_run: false,
})

Parameters:

  • options ({}) (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.



1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1829

def batch_unmonitor(options = {})
  batch_enum.each do |batch|
    params = Aws::Util.copy_hash(options)
    params[:instance_ids] ||= []
    batch.each do |item|
      params[:instance_ids] << item.id
    end
    batch[0].client.unmonitor_instances(params)
  end
  nil
end