You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::OpsWorks::Types::DescribeInstancesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb

Overview

Note:

When making an API call, you may pass DescribeInstancesRequest data as a hash:

{
  stack_id: "String",
  layer_id: "String",
  instance_ids: ["String"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#instance_idsArray<String>

An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

Returns:

  • (Array<String>)


2995
2996
2997
2998
2999
3000
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2995

class DescribeInstancesRequest < Struct.new(
  :stack_id,
  :layer_id,
  :instance_ids)
  include Aws::Structure
end

#layer_idString

A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

Returns:

  • (String)


2995
2996
2997
2998
2999
3000
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2995

class DescribeInstancesRequest < Struct.new(
  :stack_id,
  :layer_id,
  :instance_ids)
  include Aws::Structure
end

#stack_idString

A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

Returns:

  • (String)


2995
2996
2997
2998
2999
3000
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2995

class DescribeInstancesRequest < Struct.new(
  :stack_id,
  :layer_id,
  :instance_ids)
  include Aws::Structure
end