com.amazonaws.services.ec2.model

Class ModifySnapshotAttributeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.ModifySnapshotAttributeRequest

All Implemented Interfaces:

DryRunSupportedRequest<ModifySnapshotAttributeRequest>, Serializable

public class ModifySnapshotAttributeRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<ModifySnapshotAttributeRequest>

Container for the parameters to the ModifySnapshotAttribute operation.

Adds or remove permission settings for the specified snapshot.

See Also:

AmazonEC2.modifySnapshotAttribute(ModifySnapshotAttributeRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ModifySnapshotAttributeRequest() Default constructor for a new ModifySnapshotAttributeRequest object.
ModifySnapshotAttributeRequest(String snapshotId, SnapshotAttributeName attribute, String operationType) Constructs a new ModifySnapshotAttributeRequest object.
ModifySnapshotAttributeRequest(String snapshotId, String attribute, String operationType) Constructs a new ModifySnapshotAttributeRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAttribute() The name of the attribute being modified.
CreateVolumePermissionModifications	getCreateVolumePermission() Returns the value of the CreateVolumePermission property for this object.
Request<ModifySnapshotAttributeRequest>	getDryRunRequest() This method is intended for internal use only.
List<String>	getGroupNames() The AWS group names to add to or remove from the list of groups that have permission to create EBS volumes from the specified snapshot.
String	getOperationType() The operation to perform on the attribute.
String	getSnapshotId() The ID of the EBS snapshot whose attributes are being modified.
List<String>	getUserIds() The AWS user IDs to add to or remove from the list of users that have permission to create EBS volumes from the specified snapshot.
int	hashCode()
void	setAttribute(SnapshotAttributeName attribute) The name of the attribute being modified.
void	setAttribute(String attribute) The name of the attribute being modified.
void	setCreateVolumePermission(CreateVolumePermissionModifications createVolumePermission) Sets the value of the CreateVolumePermission property for this object.
void	setGroupNames(Collection<String> groupNames) The AWS group names to add to or remove from the list of groups that have permission to create EBS volumes from the specified snapshot.
void	setOperationType(String operationType) The operation to perform on the attribute.
void	setSnapshotId(String snapshotId) The ID of the EBS snapshot whose attributes are being modified.
void	setUserIds(Collection<String> userIds) The AWS user IDs to add to or remove from the list of users that have permission to create EBS volumes from the specified snapshot.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ModifySnapshotAttributeRequest	withAttribute(SnapshotAttributeName attribute) The name of the attribute being modified.
ModifySnapshotAttributeRequest	withAttribute(String attribute) The name of the attribute being modified.
ModifySnapshotAttributeRequest	withCreateVolumePermission(CreateVolumePermissionModifications createVolumePermission) Sets the value of the CreateVolumePermission property for this object.
ModifySnapshotAttributeRequest	withGroupNames(Collection<String> groupNames) The AWS group names to add to or remove from the list of groups that have permission to create EBS volumes from the specified snapshot.
ModifySnapshotAttributeRequest	withGroupNames(String... groupNames) The AWS group names to add to or remove from the list of groups that have permission to create EBS volumes from the specified snapshot.
ModifySnapshotAttributeRequest	withOperationType(String operationType) The operation to perform on the attribute.
ModifySnapshotAttributeRequest	withSnapshotId(String snapshotId) The ID of the EBS snapshot whose attributes are being modified.
ModifySnapshotAttributeRequest	withUserIds(Collection<String> userIds) The AWS user IDs to add to or remove from the list of users that have permission to create EBS volumes from the specified snapshot.
ModifySnapshotAttributeRequest	withUserIds(String... userIds) The AWS user IDs to add to or remove from the list of users that have permission to create EBS volumes from the specified snapshot.

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

ModifySnapshotAttributeRequest

public ModifySnapshotAttributeRequest()

Default constructor for a new ModifySnapshotAttributeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

ModifySnapshotAttributeRequest

public ModifySnapshotAttributeRequest(String snapshotId,
                              String attribute,
                              String operationType)

Constructs a new ModifySnapshotAttributeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

snapshotId - The ID of the EBS snapshot whose attributes are being modified.

attribute - The name of the attribute being modified.

Available attribute names: createVolumePermission

operationType - The operation to perform on the attribute.

Available operation names: add, remove

ModifySnapshotAttributeRequest

public ModifySnapshotAttributeRequest(String snapshotId,
                              SnapshotAttributeName attribute,
                              String operationType)

Constructs a new ModifySnapshotAttributeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

snapshotId - The ID of the EBS snapshot whose attributes are being modified.

attribute - The name of the attribute being modified.

Available attribute names: createVolumePermission

operationType - The operation to perform on the attribute.

Available operation names: add, remove

Method Detail

getSnapshotId

public String getSnapshotId()

The ID of the EBS snapshot whose attributes are being modified.

Returns:

The ID of the EBS snapshot whose attributes are being modified.

setSnapshotId

public void setSnapshotId(String snapshotId)

The ID of the EBS snapshot whose attributes are being modified.

Parameters:

snapshotId - The ID of the EBS snapshot whose attributes are being modified.

withSnapshotId

public ModifySnapshotAttributeRequest withSnapshotId(String snapshotId)

The ID of the EBS snapshot whose attributes are being modified.

Returns a reference to this object so that method calls can be chained together.

Parameters:

snapshotId - The ID of the EBS snapshot whose attributes are being modified.

Returns:

A reference to this updated object so that method calls can be chained together.

getAttribute

public String getAttribute()

The name of the attribute being modified.

Available attribute names: createVolumePermission

Constraints:
Allowed Values: productCodes, createVolumePermission

Returns:

The name of the attribute being modified.

Available attribute names: createVolumePermission

See Also:

SnapshotAttributeName

setAttribute

public void setAttribute(String attribute)

The name of the attribute being modified.

Available attribute names: createVolumePermission

Constraints:
Allowed Values: productCodes, createVolumePermission

Parameters:

attribute - The name of the attribute being modified.

Available attribute names: createVolumePermission

See Also:

SnapshotAttributeName

withAttribute

public ModifySnapshotAttributeRequest withAttribute(String attribute)

The name of the attribute being modified.

Available attribute names: createVolumePermission

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: productCodes, createVolumePermission

Parameters:

attribute - The name of the attribute being modified.

Available attribute names: createVolumePermission

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

SnapshotAttributeName

setAttribute

public void setAttribute(SnapshotAttributeName attribute)

The name of the attribute being modified.

Available attribute names: createVolumePermission

Constraints:
Allowed Values: productCodes, createVolumePermission

Parameters:

attribute - The name of the attribute being modified.

Available attribute names: createVolumePermission

See Also:

SnapshotAttributeName

withAttribute

public ModifySnapshotAttributeRequest withAttribute(SnapshotAttributeName attribute)

The name of the attribute being modified.

Available attribute names: createVolumePermission

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: productCodes, createVolumePermission

Parameters:

attribute - The name of the attribute being modified.

Available attribute names: createVolumePermission

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

SnapshotAttributeName

getOperationType

public String getOperationType()

The operation to perform on the attribute.

Available operation names: add, remove

Returns:

The operation to perform on the attribute.

Available operation names: add, remove

setOperationType

public void setOperationType(String operationType)

The operation to perform on the attribute.

Available operation names: add, remove

Parameters:

operationType - The operation to perform on the attribute.

Available operation names: add, remove

withOperationType

public ModifySnapshotAttributeRequest withOperationType(String operationType)

The operation to perform on the attribute.

Available operation names: add, remove

Returns a reference to this object so that method calls can be chained together.

Parameters:

operationType - The operation to perform on the attribute.

Available operation names: add, remove

Returns:

A reference to this updated object so that method calls can be chained together.

getUserIds

public List<String> getUserIds()

The AWS user IDs to add to or remove from the list of users that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

Returns:

The AWS user IDs to add to or remove from the list of users that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

setUserIds

public void setUserIds(Collection<String> userIds)

The AWS user IDs to add to or remove from the list of users that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

Parameters:

userIds - The AWS user IDs to add to or remove from the list of users that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

withUserIds

public ModifySnapshotAttributeRequest withUserIds(String... userIds)

The AWS user IDs to add to or remove from the list of users that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

Returns a reference to this object so that method calls can be chained together.

Parameters:

userIds - The AWS user IDs to add to or remove from the list of users that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

Returns:

A reference to this updated object so that method calls can be chained together.

withUserIds

public ModifySnapshotAttributeRequest withUserIds(Collection<String> userIds)

The AWS user IDs to add to or remove from the list of users that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

Returns a reference to this object so that method calls can be chained together.

Parameters:

userIds - The AWS user IDs to add to or remove from the list of users that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

Returns:

A reference to this updated object so that method calls can be chained together.

getGroupNames

public List<String> getGroupNames()

The AWS group names to add to or remove from the list of groups that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

Returns:

The AWS group names to add to or remove from the list of groups that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

setGroupNames

public void setGroupNames(Collection<String> groupNames)

The AWS group names to add to or remove from the list of groups that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

Parameters:

groupNames - The AWS group names to add to or remove from the list of groups that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

withGroupNames

public ModifySnapshotAttributeRequest withGroupNames(String... groupNames)

The AWS group names to add to or remove from the list of groups that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

Returns a reference to this object so that method calls can be chained together.

Parameters:

groupNames - The AWS group names to add to or remove from the list of groups that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

Returns:

A reference to this updated object so that method calls can be chained together.

withGroupNames

public ModifySnapshotAttributeRequest withGroupNames(Collection<String> groupNames)

The AWS group names to add to or remove from the list of groups that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

Returns a reference to this object so that method calls can be chained together.

Parameters:

groupNames - The AWS group names to add to or remove from the list of groups that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

Returns:

A reference to this updated object so that method calls can be chained together.

getCreateVolumePermission

public CreateVolumePermissionModifications getCreateVolumePermission()

Returns the value of the CreateVolumePermission property for this object.

Returns:

The value of the CreateVolumePermission property for this object.

setCreateVolumePermission

public void setCreateVolumePermission(CreateVolumePermissionModifications createVolumePermission)

Sets the value of the CreateVolumePermission property for this object.

Parameters:

createVolumePermission - The new value for the CreateVolumePermission property for this object.

withCreateVolumePermission

public ModifySnapshotAttributeRequest withCreateVolumePermission(CreateVolumePermissionModifications createVolumePermission)

Sets the value of the CreateVolumePermission property for this object.

Returns a reference to this object so that method calls can be chained together.

Parameters:

createVolumePermission - The new value for the CreateVolumePermission property for this object.

Returns:

A reference to this updated object so that method calls can be chained together.

getDryRunRequest

public Request<ModifySnapshotAttributeRequest> 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<ModifySnapshotAttributeRequest>

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