ModifyImageAttributeRequest (AWS Java SDK for Amazon EC2 1.9.28 API)

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

All Implemented Interfaces:

ReadLimitInfo, DryRunSupportedRequest<ModifyImageAttributeRequest>, Serializable, Cloneable
```
public class ModifyImageAttributeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<ModifyImageAttributeRequest>
```
Container for the parameters to the ModifyImageAttribute operation.
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

NOTE: AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

See Also:
AmazonEC2.modifyImageAttribute(ModifyImageAttributeRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description
`ModifyImageAttributeRequest()` Default constructor for a new ModifyImageAttributeRequest object.
`ModifyImageAttributeRequest(String imageId, String attribute)` Constructs a new ModifyImageAttributeRequest object.

Method Summary

Methods
Modifier and Type	Method and Description
`ModifyImageAttributeRequest`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAttribute()` The name of the attribute to modify.
`String`	`getDescription()` A description for the AMI.
`Request<ModifyImageAttributeRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`String`	`getImageId()` The ID of the AMI.
`LaunchPermissionModifications`	`getLaunchPermission()` A launch permission modification.
`String`	`getOperationType()` The operation type.
`List<String>`	`getProductCodes()` One or more product codes.
`List<String>`	`getUserGroups()` One or more user groups.
`List<String>`	`getUserIds()` One or more AWS account IDs.
`String`	`getValue()` The value of the attribute being modified.
`int`	`hashCode()`
`void`	`setAttribute(String attribute)` The name of the attribute to modify.
`void`	`setDescription(String description)` A description for the AMI.
`void`	`setImageId(String imageId)` The ID of the AMI.
`void`	`setLaunchPermission(LaunchPermissionModifications launchPermission)` A launch permission modification.
`void`	`setOperationType(String operationType)` The operation type.
`void`	`setProductCodes(Collection<String> productCodes)` One or more product codes.
`void`	`setUserGroups(Collection<String> userGroups)` One or more user groups.
`void`	`setUserIds(Collection<String> userIds)` One or more AWS account IDs.
`void`	`setValue(String value)` The value of the attribute being modified.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ModifyImageAttributeRequest`	`withAttribute(String attribute)` The name of the attribute to modify.
`ModifyImageAttributeRequest`	`withDescription(String description)` A description for the AMI.
`ModifyImageAttributeRequest`	`withImageId(String imageId)` The ID of the AMI.
`ModifyImageAttributeRequest`	`withLaunchPermission(LaunchPermissionModifications launchPermission)` A launch permission modification.
`ModifyImageAttributeRequest`	`withOperationType(String operationType)` The operation type.
`ModifyImageAttributeRequest`	`withProductCodes(Collection<String> productCodes)` One or more product codes.
`ModifyImageAttributeRequest`	`withProductCodes(String... productCodes)` One or more product codes.
`ModifyImageAttributeRequest`	`withUserGroups(Collection<String> userGroups)` One or more user groups.
`ModifyImageAttributeRequest`	`withUserGroups(String... userGroups)` One or more user groups.
`ModifyImageAttributeRequest`	`withUserIds(Collection<String> userIds)` One or more AWS account IDs.
`ModifyImageAttributeRequest`	`withUserIds(String... userIds)` One or more AWS account IDs.
`ModifyImageAttributeRequest`	`withValue(String value)` The value of the attribute being modified.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - ModifyImageAttributeRequest
```
public ModifyImageAttributeRequest()
```
    Default constructor for a new ModifyImageAttributeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.
  - ModifyImageAttributeRequest
```
public ModifyImageAttributeRequest(String imageId,
                           String attribute)
```
    Constructs a new ModifyImageAttributeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    Parameters:
    imageId - The ID of the AMI.
    attribute - The name of the attribute to modify.
- Method Detail
  - getImageId
```
public String getImageId()
```
    The ID of the AMI.
    
    Returns:
    The ID of the AMI.
  - setImageId
```
public void setImageId(String imageId)
```
    The ID of the AMI.
    
    Parameters:
    imageId - The ID of the AMI.
  - withImageId
```
public ModifyImageAttributeRequest withImageId(String imageId)
```
    The ID of the AMI.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    imageId - The ID of the AMI.
    
    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 modify.
    
    Returns:
    The name of the attribute to modify.
  - setAttribute
```
public void setAttribute(String attribute)
```
    The name of the attribute to modify.
    
    Parameters:
    attribute - The name of the attribute to modify.
  - withAttribute
```
public ModifyImageAttributeRequest withAttribute(String attribute)
```
    The name of the attribute to modify.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    attribute - The name of the attribute to modify.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getOperationType
```
public String getOperationType()
```
    The operation type.
    
    Returns:
    The operation type.
  - setOperationType
```
public void setOperationType(String operationType)
```
    The operation type.
    
    Parameters:
    operationType - The operation type.
  - withOperationType
```
public ModifyImageAttributeRequest withOperationType(String operationType)
```
    The operation type.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    operationType - The operation type.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getUserIds
```
public List<String> getUserIds()
```
    One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.
    
    Returns:
    One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.
  - setUserIds
```
public void setUserIds(Collection<String> userIds)
```
    One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.
    
    Parameters:
    userIds - One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.
  - withUserIds
```
public ModifyImageAttributeRequest withUserIds(String... userIds)
```
    One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    userIds - One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withUserIds
```
public ModifyImageAttributeRequest withUserIds(Collection<String> userIds)
```
    One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    userIds - One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getUserGroups
```
public List<String> getUserGroups()
```
    One or more user groups. This is only valid when modifying the launchPermission attribute.
    
    Returns:
    One or more user groups. This is only valid when modifying the launchPermission attribute.
  - setUserGroups
```
public void setUserGroups(Collection<String> userGroups)
```
    One or more user groups. This is only valid when modifying the launchPermission attribute.
    
    Parameters:
    userGroups - One or more user groups. This is only valid when modifying the launchPermission attribute.
  - withUserGroups
```
public ModifyImageAttributeRequest withUserGroups(String... userGroups)
```
    One or more user groups. This is only valid when modifying the launchPermission attribute.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    userGroups - One or more user groups. This is only valid when modifying the launchPermission attribute.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withUserGroups
```
public ModifyImageAttributeRequest withUserGroups(Collection<String> userGroups)
```
    One or more user groups. This is only valid when modifying the launchPermission attribute.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    userGroups - One or more user groups. This is only valid when modifying the launchPermission attribute.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getProductCodes
```
public List<String> getProductCodes()
```
    One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.
    
    Returns:
    One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.
  - setProductCodes
```
public void setProductCodes(Collection<String> productCodes)
```
    One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.
    
    Parameters:
    productCodes - One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.
  - withProductCodes
```
public ModifyImageAttributeRequest withProductCodes(String... productCodes)
```
    One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    productCodes - One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withProductCodes
```
public ModifyImageAttributeRequest withProductCodes(Collection<String> productCodes)
```
    One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    productCodes - One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getValue
```
public String getValue()
```
    The value of the attribute being modified. This is only valid when modifying the description attribute.
    
    Returns:
    The value of the attribute being modified. This is only valid when modifying the description attribute.
  - setValue
```
public void setValue(String value)
```
    The value of the attribute being modified. This is only valid when modifying the description attribute.
    
    Parameters:
    value - The value of the attribute being modified. This is only valid when modifying the description attribute.
  - withValue
```
public ModifyImageAttributeRequest withValue(String value)
```
    The value of the attribute being modified. This is only valid when modifying the description attribute.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    value - The value of the attribute being modified. This is only valid when modifying the description attribute.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getLaunchPermission
```
public LaunchPermissionModifications getLaunchPermission()
```
    A launch permission modification.
    
    Returns:
    A launch permission modification.
  - setLaunchPermission
```
public void setLaunchPermission(LaunchPermissionModifications launchPermission)
```
    A launch permission modification.
    
    Parameters:
    launchPermission - A launch permission modification.
  - withLaunchPermission
```
public ModifyImageAttributeRequest withLaunchPermission(LaunchPermissionModifications launchPermission)
```
    A launch permission modification.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    launchPermission - A launch permission modification.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDescription
```
public String getDescription()
```
    A description for the AMI.
    
    Returns:
    A description for the AMI.
  - setDescription
```
public void setDescription(String description)
```
    A description for the AMI.
    
    Parameters:
    description - A description for the AMI.
  - withDescription
```
public ModifyImageAttributeRequest withDescription(String description)
```
    A description for the AMI.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    description - A description for the AMI.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDryRunRequest
```
public Request<ModifyImageAttributeRequest> 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<ModifyImageAttributeRequest>
  - 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
  - clone
```
public ModifyImageAttributeRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class ModifyImageAttributeRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ModifyImageAttributeRequest

ModifyImageAttributeRequest

Method Detail

getImageId

setImageId

withImageId

getAttribute

setAttribute

withAttribute

getOperationType

setOperationType

withOperationType

getUserIds

setUserIds

withUserIds

withUserIds

getUserGroups

setUserGroups

withUserGroups

withUserGroups

getProductCodes

setProductCodes

withProductCodes

withProductCodes

getValue

setValue

withValue

getLaunchPermission

setLaunchPermission

withLaunchPermission

getDescription

setDescription

withDescription

getDryRunRequest

toString

hashCode

equals

clone