Class AddPermissionRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.sns.model.AddPermissionRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class AddPermissionRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
See Also:
  • Constructor Details

    • AddPermissionRequest

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

      public AddPermissionRequest(String topicArn, String label, List<String> aWSAccountIds, List<String> actionNames)
      Constructs a new AddPermissionRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      Parameters:
      topicArn - The ARN of the topic whose access control policy you wish to modify.
      label - A unique identifier for the new policy statement.
      aWSAccountIds - The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.
      actionNames - The action you want to allow for the specified principal(s).

      Valid values: any Amazon SNS action name.

  • Method Details

    • setTopicArn

      public void setTopicArn(String topicArn)

      The ARN of the topic whose access control policy you wish to modify.

      Parameters:
      topicArn - The ARN of the topic whose access control policy you wish to modify.
    • getTopicArn

      public String getTopicArn()

      The ARN of the topic whose access control policy you wish to modify.

      Returns:
      The ARN of the topic whose access control policy you wish to modify.
    • withTopicArn

      public AddPermissionRequest withTopicArn(String topicArn)

      The ARN of the topic whose access control policy you wish to modify.

      Parameters:
      topicArn - The ARN of the topic whose access control policy you wish to modify.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setLabel

      public void setLabel(String label)

      A unique identifier for the new policy statement.

      Parameters:
      label - A unique identifier for the new policy statement.
    • getLabel

      public String getLabel()

      A unique identifier for the new policy statement.

      Returns:
      A unique identifier for the new policy statement.
    • withLabel

      public AddPermissionRequest withLabel(String label)

      A unique identifier for the new policy statement.

      Parameters:
      label - A unique identifier for the new policy statement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getAWSAccountIds

      public List<String> getAWSAccountIds()

      The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.

      Returns:
      The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.
    • setAWSAccountIds

      public void setAWSAccountIds(Collection<String> aWSAccountIds)

      The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.

      Parameters:
      aWSAccountIds - The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.
    • withAWSAccountIds

      public AddPermissionRequest withAWSAccountIds(String... aWSAccountIds)

      The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.

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

      Parameters:
      aWSAccountIds - The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withAWSAccountIds

      public AddPermissionRequest withAWSAccountIds(Collection<String> aWSAccountIds)

      The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.

      Parameters:
      aWSAccountIds - The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getActionNames

      public List<String> getActionNames()

      The action you want to allow for the specified principal(s).

      Valid values: any Amazon SNS action name.

      Returns:
      The action you want to allow for the specified principal(s).

      Valid values: any Amazon SNS action name.

    • setActionNames

      public void setActionNames(Collection<String> actionNames)

      The action you want to allow for the specified principal(s).

      Valid values: any Amazon SNS action name.

      Parameters:
      actionNames - The action you want to allow for the specified principal(s).

      Valid values: any Amazon SNS action name.

    • withActionNames

      public AddPermissionRequest withActionNames(String... actionNames)

      The action you want to allow for the specified principal(s).

      Valid values: any Amazon SNS action name.

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

      Parameters:
      actionNames - The action you want to allow for the specified principal(s).

      Valid values: any Amazon SNS action name.

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

      public AddPermissionRequest withActionNames(Collection<String> actionNames)

      The action you want to allow for the specified principal(s).

      Valid values: any Amazon SNS action name.

      Parameters:
      actionNames - The action you want to allow for the specified principal(s).

      Valid values: any Amazon SNS action name.

      Returns:
      Returns a reference to this 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public AddPermissionRequest 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: