com.amazonaws.services.rds.model

Class ModifyDBSnapshotAttributeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.ModifyDBSnapshotAttributeRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ModifyDBSnapshotAttributeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ModifyDBSnapshotAttribute operation.

Adds an attribute and values to, or removes an attribute and values from a manual DB snapshot.

To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of the AWS account ids that are authorized to retore the manual DB snapshot. Uses the value all to make the manual DB snapshot public and can by copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you do not want to be available to all AWS accounts.

To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API.

If the manual DB snapshot is encrypted, it cannot be shared.

See Also:

AmazonRDS.modifyDBSnapshotAttribute(ModifyDBSnapshotAttributeRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ModifyDBSnapshotAttributeRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ModifyDBSnapshotAttributeRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAttributeName() The name of the DB snapshot attribute to modify.
String	getDBSnapshotIdentifier() The identifier for the DB snapshot to modify the attributes for.
List<String>	getValuesToAdd() A list of DB snapshot attributes to add to the attribute specified by AttributeName.
List<String>	getValuesToRemove() A list of DB snapshot attributes to remove from the attribute specified by AttributeName.
int	hashCode()
void	setAttributeName(String attributeName) The name of the DB snapshot attribute to modify.
void	setDBSnapshotIdentifier(String dBSnapshotIdentifier) The identifier for the DB snapshot to modify the attributes for.
void	setValuesToAdd(Collection<String> valuesToAdd) A list of DB snapshot attributes to add to the attribute specified by AttributeName.
void	setValuesToRemove(Collection<String> valuesToRemove) A list of DB snapshot attributes to remove from the attribute specified by AttributeName.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ModifyDBSnapshotAttributeRequest	withAttributeName(String attributeName) The name of the DB snapshot attribute to modify.
ModifyDBSnapshotAttributeRequest	withDBSnapshotIdentifier(String dBSnapshotIdentifier) The identifier for the DB snapshot to modify the attributes for.
ModifyDBSnapshotAttributeRequest	withValuesToAdd(Collection<String> valuesToAdd) A list of DB snapshot attributes to add to the attribute specified by AttributeName.
ModifyDBSnapshotAttributeRequest	withValuesToAdd(String... valuesToAdd) A list of DB snapshot attributes to add to the attribute specified by AttributeName.
ModifyDBSnapshotAttributeRequest	withValuesToRemove(Collection<String> valuesToRemove) A list of DB snapshot attributes to remove from the attribute specified by AttributeName.
ModifyDBSnapshotAttributeRequest	withValuesToRemove(String... valuesToRemove) A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifyDBSnapshotAttributeRequest

public ModifyDBSnapshotAttributeRequest()

Method Detail

getDBSnapshotIdentifier

public String getDBSnapshotIdentifier()

The identifier for the DB snapshot to modify the attributes for.

Returns:

The identifier for the DB snapshot to modify the attributes for.

setDBSnapshotIdentifier

public void setDBSnapshotIdentifier(String dBSnapshotIdentifier)

The identifier for the DB snapshot to modify the attributes for.

Parameters:

dBSnapshotIdentifier - The identifier for the DB snapshot to modify the attributes for.

withDBSnapshotIdentifier

public ModifyDBSnapshotAttributeRequest withDBSnapshotIdentifier(String dBSnapshotIdentifier)

The identifier for the DB snapshot to modify the attributes for.

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

Parameters:

dBSnapshotIdentifier - The identifier for the DB snapshot to modify the attributes for.

Returns:

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

getAttributeName

public String getAttributeName()

The name of the DB snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, this value is restore.

Returns:

The name of the DB snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, this value is restore.

setAttributeName

public void setAttributeName(String attributeName)

The name of the DB snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, this value is restore.

Parameters:

attributeName - The name of the DB snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, this value is restore.

withAttributeName

public ModifyDBSnapshotAttributeRequest withAttributeName(String attributeName)

The name of the DB snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, this value is restore.

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

Parameters:

attributeName - The name of the DB snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, this value is restore.

Returns:

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

getValuesToAdd

public List<String> getValuesToAdd()

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

To authorize other AWS Accounts to copy or restore a manual snapshot, this is one or more AWS account identifiers, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you do not want to be available to all AWS accounts.

Returns:

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

To authorize other AWS Accounts to copy or restore a manual snapshot, this is one or more AWS account identifiers, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you do not want to be available to all AWS accounts.

setValuesToAdd

public void setValuesToAdd(Collection<String> valuesToAdd)

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

To authorize other AWS Accounts to copy or restore a manual snapshot, this is one or more AWS account identifiers, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you do not want to be available to all AWS accounts.

Parameters:

valuesToAdd - A list of DB snapshot attributes to add to the attribute specified by AttributeName.

To authorize other AWS Accounts to copy or restore a manual snapshot, this is one or more AWS account identifiers, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you do not want to be available to all AWS accounts.

withValuesToAdd

public ModifyDBSnapshotAttributeRequest withValuesToAdd(String... valuesToAdd)

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

To authorize other AWS Accounts to copy or restore a manual snapshot, this is one or more AWS account identifiers, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you do not want to be available to all AWS accounts.

NOTE: This method appends the values to the existing list (if any). Use setValuesToAdd(java.util.Collection) or withValuesToAdd(java.util.Collection) if you want to override the existing values.

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

Parameters:

valuesToAdd - A list of DB snapshot attributes to add to the attribute specified by AttributeName.

To authorize other AWS Accounts to copy or restore a manual snapshot, this is one or more AWS account identifiers, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you do not want to be available to all AWS accounts.

Returns:

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

withValuesToAdd

public ModifyDBSnapshotAttributeRequest withValuesToAdd(Collection<String> valuesToAdd)

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

To authorize other AWS Accounts to copy or restore a manual snapshot, this is one or more AWS account identifiers, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you do not want to be available to all AWS accounts.

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

Parameters:

valuesToAdd - A list of DB snapshot attributes to add to the attribute specified by AttributeName.

To authorize other AWS Accounts to copy or restore a manual snapshot, this is one or more AWS account identifiers, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you do not want to be available to all AWS accounts.

Returns:

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

getValuesToRemove

public List<String> getValuesToRemove()

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other AWS Accounts to copy or restore a manual snapshot, this is one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, AWS accounts that have their account identifier explicitly added to the restore attribute can still copy or restore the manual DB snapshot.

Returns:

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other AWS Accounts to copy or restore a manual snapshot, this is one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, AWS accounts that have their account identifier explicitly added to the restore attribute can still copy or restore the manual DB snapshot.

setValuesToRemove

public void setValuesToRemove(Collection<String> valuesToRemove)

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other AWS Accounts to copy or restore a manual snapshot, this is one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, AWS accounts that have their account identifier explicitly added to the restore attribute can still copy or restore the manual DB snapshot.

Parameters:

valuesToRemove - A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other AWS Accounts to copy or restore a manual snapshot, this is one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, AWS accounts that have their account identifier explicitly added to the restore attribute can still copy or restore the manual DB snapshot.

withValuesToRemove

public ModifyDBSnapshotAttributeRequest withValuesToRemove(String... valuesToRemove)

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other AWS Accounts to copy or restore a manual snapshot, this is one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, AWS accounts that have their account identifier explicitly added to the restore attribute can still copy or restore the manual DB snapshot.

NOTE: This method appends the values to the existing list (if any). Use setValuesToRemove(java.util.Collection) or withValuesToRemove(java.util.Collection) if you want to override the existing values.

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

Parameters:

valuesToRemove - A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other AWS Accounts to copy or restore a manual snapshot, this is one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, AWS accounts that have their account identifier explicitly added to the restore attribute can still copy or restore the manual DB snapshot.

Returns:

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

withValuesToRemove

public ModifyDBSnapshotAttributeRequest withValuesToRemove(Collection<String> valuesToRemove)

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other AWS Accounts to copy or restore a manual snapshot, this is one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, AWS accounts that have their account identifier explicitly added to the restore attribute can still copy or restore the manual DB snapshot.

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

Parameters:

valuesToRemove - A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other AWS Accounts to copy or restore a manual snapshot, this is one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, AWS accounts that have their account identifier explicitly added to the restore attribute can still copy or restore the manual DB snapshot.

Returns:

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

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 ModifyDBSnapshotAttributeRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()