DescribeInstanceAttributeRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.ec2.model.DescribeInstanceAttributeRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeInstanceAttributeRequest>, Serializable
```
public class DescribeInstanceAttributeRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<DescribeInstanceAttributeRequest>
```
Container for the parameters to the DescribeInstanceAttribute operation.
Returns information about an attribute of an instance. Only one attribute can be specified per call.

See Also:
AmazonEC2.describeInstanceAttribute(DescribeInstanceAttributeRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description
`DescribeInstanceAttributeRequest()` Default constructor for a new DescribeInstanceAttributeRequest object.
`DescribeInstanceAttributeRequest(String instanceId, InstanceAttributeName attribute)` Constructs a new DescribeInstanceAttributeRequest object.
`DescribeInstanceAttributeRequest(String instanceId, String attribute)` Constructs a new DescribeInstanceAttributeRequest object.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAttribute()` The name of the attribute to describe.
`Request<DescribeInstanceAttributeRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`String`	`getInstanceId()` The ID of the instance whose instance attribute is being described.
`int`	`hashCode()`
`void`	`setAttribute(InstanceAttributeName attribute)` The name of the attribute to describe.
`void`	`setAttribute(String attribute)` The name of the attribute to describe.
`void`	`setInstanceId(String instanceId)` The ID of the instance whose instance attribute is being described.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeInstanceAttributeRequest`	`withAttribute(InstanceAttributeName attribute)` The name of the attribute to describe.
`DescribeInstanceAttributeRequest`	`withAttribute(String attribute)` The name of the attribute to describe.
`DescribeInstanceAttributeRequest`	`withInstanceId(String instanceId)` The ID of the instance whose instance attribute is being described.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeInstanceAttributeRequest
```
public DescribeInstanceAttributeRequest()
```
    Default constructor for a new DescribeInstanceAttributeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.
  - DescribeInstanceAttributeRequest
```
public DescribeInstanceAttributeRequest(String instanceId,
                                String attribute)
```
    Constructs a new DescribeInstanceAttributeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    Parameters:
    instanceId - The ID of the instance whose instance attribute is being described.
    attribute - The name of the attribute to describe.
    Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping
  - DescribeInstanceAttributeRequest
```
public DescribeInstanceAttributeRequest(String instanceId,
                                InstanceAttributeName attribute)
```
    Constructs a new DescribeInstanceAttributeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    Parameters:
    instanceId - The ID of the instance whose instance attribute is being described.
    attribute - The name of the attribute to describe.
    Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping
- Method Detail
  - getInstanceId
```
public String getInstanceId()
```
    The ID of the instance whose instance attribute is being described.
    
    Returns:
    The ID of the instance whose instance attribute is being described.
  - setInstanceId
```
public void setInstanceId(String instanceId)
```
    The ID of the instance whose instance attribute is being described.
    
    Parameters:
    instanceId - The ID of the instance whose instance attribute is being described.
  - withInstanceId
```
public DescribeInstanceAttributeRequest withInstanceId(String instanceId)
```
    The ID of the instance whose instance attribute is being described.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    instanceId - The ID of the instance whose instance attribute is being described.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAttribute
```
public String getAttribute()
```
    The name of the attribute to describe.
    Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping
    Constraints:
    Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized
    
    Returns:
    The name of the attribute to describe.
    Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping
    See Also:
    InstanceAttributeName
  - setAttribute
```
public void setAttribute(String attribute)
```
    The name of the attribute to describe.
    Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping
    Constraints:
    Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized
    
    Parameters:
    attribute - The name of the attribute to describe.
    Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping
    See Also:
    InstanceAttributeName
  - withAttribute
```
public DescribeInstanceAttributeRequest withAttribute(String attribute)
```
    The name of the attribute to describe.
    Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized
    
    Parameters:
    attribute - The name of the attribute to describe.
    Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    InstanceAttributeName
  - setAttribute
```
public void setAttribute(InstanceAttributeName attribute)
```
    The name of the attribute to describe.
    Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping
    Constraints:
    Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized
    
    Parameters:
    attribute - The name of the attribute to describe.
    Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping
    See Also:
    InstanceAttributeName
  - withAttribute
```
public DescribeInstanceAttributeRequest withAttribute(InstanceAttributeName attribute)
```
    The name of the attribute to describe.
    Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized
    
    Parameters:
    attribute - The name of the attribute to describe.
    Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    InstanceAttributeName
  - getDryRunRequest
```
public Request<DescribeInstanceAttributeRequest> getDryRunRequest()
```
    This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.
    
    Specified by:
    
    getDryRunRequest in interface DryRunSupportedRequest<DescribeInstanceAttributeRequest>
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class DescribeInstanceAttributeRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeInstanceAttributeRequest

DescribeInstanceAttributeRequest

DescribeInstanceAttributeRequest

Method Detail

getInstanceId

setInstanceId

withInstanceId

getAttribute

setAttribute

withAttribute

setAttribute

withAttribute

getDryRunRequest

toString

hashCode

equals