Package software.amazon.awssdk.services.transfer.model

Interface DescribeAccessRequest.Builder

    • Method Detail

      • serverId

        DescribeAccessRequest.Builder serverId​(String serverId)

        A system-assigned unique identifier for a server that has this access assigned.

        Parameters:
        serverId - A system-assigned unique identifier for a server that has this access assigned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • externalId

        DescribeAccessRequest.Builder externalId​(String externalId)

        A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

        Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

        In that command, replace YourGroupName with the name of your Active Directory group.

        The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

        Parameters:
        externalId - A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

        Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

        In that command, replace YourGroupName with the name of your Active Directory group.

        The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

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