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

Inherits:

Resources::Collection

• Object
• Resources::Collection
• Aws::EC2::Instance::Collection

Extended by:

Deprecations

Defined in:

lib/aws-sdk-ec2/customizations/instance.rb,
lib/aws-sdk-ec2/instance.rb

Batch Actions

• #batch_create_tags(options = {}) ⇒ void
• #batch_delete_tags!(options = {}) ⇒ void
• #batch_monitor(options = {}) ⇒ void
• #batch_reboot(options = {}) ⇒ void
• #batch_start(options = {}) ⇒ void
• #batch_stop(options = {}) ⇒ void
• #batch_terminate!(options = {}) ⇒ void
• #batch_unmonitor(options = {}) ⇒ void

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.

# File 'lib/aws-sdk-ec2/instance.rb', line 1864

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
    Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      batch[0].client.create_tags(params)
    end
  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 Amazon Web Services-generated tags (tags that have the ‘aws:` prefix).

  Constraints: Up to 1000 tags.

# File 'lib/aws-sdk-ec2/instance.rb', line 1908

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
    Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      batch[0].client.delete_tags(params)
    end
  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 operation, 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`.

# File 'lib/aws-sdk-ec2/instance.rb', line 1934

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
    Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      batch[0].client.monitor_instances(params)
    end
  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 operation, 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`.

# File 'lib/aws-sdk-ec2/instance.rb', line 1960

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
    Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      batch[0].client.reboot_instances(params)
    end
  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 operation, 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`.

# File 'lib/aws-sdk-ec2/instance.rb', line 1989

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
    Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      batch[0].client.start_instances(params)
    end
  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 EC2 User Guide*.

  Default: ‘false`

  [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html

• :dry_run (Boolean) —

  Checks whether you have the required permissions for the operation, 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`

# File 'lib/aws-sdk-ec2/instance.rb', line 2035

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
    Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      batch[0].client.stop_instances(params)
    end
  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 operation, 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`.

# File 'lib/aws-sdk-ec2/instance.rb', line 2061

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
    Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      batch[0].client.terminate_instances(params)
    end
  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 operation, 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`.

# File 'lib/aws-sdk-ec2/instance.rb', line 2087

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
    Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      batch[0].client.unmonitor_instances(params)
    end
  end
  nil
end