Class ModifyDocumentPermissionRequest

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

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

    • ModifyDocumentPermissionRequest

      public ModifyDocumentPermissionRequest()
  • Method Details

    • setName

      public void setName(String name)

      The name of the document that you want to share.

      Parameters:
      name - The name of the document that you want to share.
    • getName

      public String getName()

      The name of the document that you want to share.

      Returns:
      The name of the document that you want to share.
    • withName

      public ModifyDocumentPermissionRequest withName(String name)

      The name of the document that you want to share.

      Parameters:
      name - The name of the document that you want to share.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setPermissionType

      public void setPermissionType(String permissionType)

      The permission type for the document. The permission type can be Share.

      Parameters:
      permissionType - The permission type for the document. The permission type can be Share.
      See Also:
    • getPermissionType

      public String getPermissionType()

      The permission type for the document. The permission type can be Share.

      Returns:
      The permission type for the document. The permission type can be Share.
      See Also:
    • withPermissionType

      public ModifyDocumentPermissionRequest withPermissionType(String permissionType)

      The permission type for the document. The permission type can be Share.

      Parameters:
      permissionType - The permission type for the document. The permission type can be Share.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setPermissionType

      public void setPermissionType(DocumentPermissionType permissionType)

      The permission type for the document. The permission type can be Share.

      Parameters:
      permissionType - The permission type for the document. The permission type can be Share.
      See Also:
    • withPermissionType

      public ModifyDocumentPermissionRequest withPermissionType(DocumentPermissionType permissionType)

      The permission type for the document. The permission type can be Share.

      Parameters:
      permissionType - The permission type for the document. The permission type can be Share.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • getAccountIdsToAdd

      public List<String> getAccountIdsToAdd()

      The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.

      Returns:
      The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
    • setAccountIdsToAdd

      public void setAccountIdsToAdd(Collection<String> accountIdsToAdd)

      The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.

      Parameters:
      accountIdsToAdd - The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
    • withAccountIdsToAdd

      public ModifyDocumentPermissionRequest withAccountIdsToAdd(String... accountIdsToAdd)

      The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.

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

      Parameters:
      accountIdsToAdd - The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withAccountIdsToAdd

      public ModifyDocumentPermissionRequest withAccountIdsToAdd(Collection<String> accountIdsToAdd)

      The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.

      Parameters:
      accountIdsToAdd - The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getAccountIdsToRemove

      public List<String> getAccountIdsToRemove()

      The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.

      Returns:
      The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.
    • setAccountIdsToRemove

      public void setAccountIdsToRemove(Collection<String> accountIdsToRemove)

      The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.

      Parameters:
      accountIdsToRemove - The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.
    • withAccountIdsToRemove

      public ModifyDocumentPermissionRequest withAccountIdsToRemove(String... accountIdsToRemove)

      The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.

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

      Parameters:
      accountIdsToRemove - The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withAccountIdsToRemove

      public ModifyDocumentPermissionRequest withAccountIdsToRemove(Collection<String> accountIdsToRemove)

      The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.

      Parameters:
      accountIdsToRemove - The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.
      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

      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: