Package software.amazon.awssdk.services.sqs.model

Class AddPermissionRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.sqs.model.AddPermissionRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>

@Generated("software.amazon.awssdk:codegen")
public class AddPermissionRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AddPermissionRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
List<String>	actions()	The action the client wants to allow for the specified principal.
List<String>	awsAccountIds()	The AWS account number of the principal who is given permission.
static AddPermissionRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
String	label()	The unique identification of the permission you're setting (for example, AliceSendMessage).
String	queueUrl()	The URL of the Amazon SQS queue to which permissions are added.
static Class<? extends AddPermissionRequest.Builder>	serializableBuilderClass()
AddPermissionRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

queueUrl

public String queueUrl()

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs are case-sensitive.

Returns:

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs are case-sensitive.

label

public String label()

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores ( _).

Returns:

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

awsAccountIds

public List<String> awsAccountIds()

The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon SQS Developer Guide.

Returns:

The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon SQS Developer Guide.

actions

public List<String> actions()

The action the client wants to allow for the specified principal. The following values are valid:

• *

• ChangeMessageVisibility

• DeleteMessage

• GetQueueAttributes

• GetQueueUrl

• ReceiveMessage

• SendMessage

For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Returns:

The action the client wants to allow for the specified principal. The following values are valid:

• *

• ChangeMessageVisibility

• DeleteMessage

• GetQueueAttributes

• GetQueueUrl

• ReceiveMessage

• SendMessage

For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

toBuilder

public AddPermissionRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>

Returns:

a builder for type T

builder

public static AddPermissionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AddPermissionRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object