com.amazonaws.services.sqs.model

Class AddPermissionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sqs.model.AddPermissionRequest

All Implemented Interfaces:

Serializable

public class AddPermissionRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the AddPermission operation.

The AddPermission action adds a permission to a queue for a specific principal . This allows for sharing access to the queue.

When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide.

AddPermission writes an SQS-generated policy. If you want to write your own policy, use SetQueueAttributes to upload your policy. For more information about writing your own policy, see Appendix: The Access Policy Language in the Amazon SQS Developer Guide.

See Also:

AmazonSQS.addPermission(AddPermissionRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
AddPermissionRequest() Default constructor for a new AddPermissionRequest object.
AddPermissionRequest(String queueUrl, String label, List<String> aWSAccountIds, List<String> actions) Constructs a new AddPermissionRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getActions() The action the client wants to allow for the specified principal.
List<String>	getAWSAccountIds() The AWS account number of the principal who will be given permission.
String	getLabel() The unique identification of the permission you're setting (e.g., AliceSendMessage).
String	getQueueUrl() The URL of the SQS queue to take action on.
int	hashCode()
void	setActions(Collection<String> actions) The action the client wants to allow for the specified principal.
void	setAWSAccountIds(Collection<String> aWSAccountIds) The AWS account number of the principal who will be given permission.
void	setLabel(String label) The unique identification of the permission you're setting (e.g., AliceSendMessage).
void	setQueueUrl(String queueUrl) The URL of the SQS queue to take action on.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AddPermissionRequest	withActions(Collection<String> actions) The action the client wants to allow for the specified principal.
AddPermissionRequest	withActions(String... actions) The action the client wants to allow for the specified principal.
AddPermissionRequest	withAWSAccountIds(Collection<String> aWSAccountIds) The AWS account number of the principal who will be given permission.
AddPermissionRequest	withAWSAccountIds(String... aWSAccountIds) The AWS account number of the principal who will be given permission.
AddPermissionRequest	withLabel(String label) The unique identification of the permission you're setting (e.g., AliceSendMessage).
AddPermissionRequest	withQueueUrl(String queueUrl) The URL of the SQS queue to take action on.

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

AddPermissionRequest

public AddPermissionRequest()

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

AddPermissionRequest

public AddPermissionRequest(String queueUrl,
                    String label,
                    List<String> aWSAccountIds,
                    List<String> actions)

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

Parameters:

queueUrl - The URL of the SQS queue to take action on.

label - The unique identification of the permission you're setting (e.g., AliceSendMessage). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.

aWSAccountIds - The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS.

actions - The action the client wants to allow for the specified principal.

Method Detail

getQueueUrl

public String getQueueUrl()

The URL of the SQS queue to take action on.

Returns:

The URL of the SQS queue to take action on.

setQueueUrl

public void setQueueUrl(String queueUrl)

The URL of the SQS queue to take action on.

Parameters:

queueUrl - The URL of the SQS queue to take action on.

withQueueUrl

public AddPermissionRequest withQueueUrl(String queueUrl)

The URL of the SQS queue to take action on.

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

Parameters:

queueUrl - The URL of the SQS queue to take action on.

Returns:

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

getLabel

public String getLabel()

The unique identification of the permission you're setting (e.g., AliceSendMessage). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.

Returns:

The unique identification of the permission you're setting (e.g., AliceSendMessage). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.

setLabel

public void setLabel(String label)

The unique identification of the permission you're setting (e.g., AliceSendMessage). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.

Parameters:

label - The unique identification of the permission you're setting (e.g., AliceSendMessage). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.

withLabel

public AddPermissionRequest withLabel(String label)

The unique identification of the permission you're setting (e.g., AliceSendMessage). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.

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

Parameters:

label - The unique identification of the permission you're setting (e.g., AliceSendMessage). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.

Returns:

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

getAWSAccountIds

public List<String> getAWSAccountIds()

The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS.

Returns:

The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS.

setAWSAccountIds

public void setAWSAccountIds(Collection<String> aWSAccountIds)

The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS.

Parameters:

aWSAccountIds - The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS.

withAWSAccountIds

public AddPermissionRequest withAWSAccountIds(String... aWSAccountIds)

The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS.

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

Parameters:

aWSAccountIds - The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS.

Returns:

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

withAWSAccountIds

public AddPermissionRequest withAWSAccountIds(Collection<String> aWSAccountIds)

The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS.

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

Parameters:

aWSAccountIds - The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS.

Returns:

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

getActions

public List<String> getActions()

The action the client wants to allow for the specified principal.

Returns:

The action the client wants to allow for the specified principal.

setActions

public void setActions(Collection<String> actions)

The action the client wants to allow for the specified principal.

Parameters:

actions - The action the client wants to allow for the specified principal.

withActions

public AddPermissionRequest withActions(String... actions)

The action the client wants to allow for the specified principal.

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

Parameters:

actions - The action the client wants to allow for the specified principal.

Returns:

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

withActions

public AddPermissionRequest withActions(Collection<String> actions)

The action the client wants to allow for the specified principal.

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

Parameters:

actions - The action the client wants to allow for the specified principal.

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